add-afs-man-pages-20010716
[openafs.git] / src / man / vos_listvol.1
1 vos listvol                AFS Commands             vos listvol
2
3
4 NAME
5
6    vos listvol -- show information from volume header(s).
7
8
9    vos listvol  -server <machine name>  [-partition <partition
10    name>]  [-fast]
11    [-long]  [-quiet]  [-cell <cell name>]  [-noauth]
12    [-localauth]
13    [-verbose]  [-help]
14
15 ACCEPTABLE ABBREVIATIONS/ALIASES
16
17    vos listvo  -s <machine name>  [-p <partition name>]  [-f]
18    [-lon]  [-q]
19    [-c <cell name>]  [-n]  [-loc]  [-v]  [-h]
20
21 DESCRIPTION
22
23    Formats  and  displays information from the volume header of
24    the indicated volumes: the volume's name,  volumeID  number,
25    type, size and status at the server.
26
27    To display volume header information for:
28
29       - every volume on a file server machine, specify the
30         machine's name with -server.
31
32       - every volume at a  particular  site,  provide  the
33         file  server  machine  name  with  -server and the
34         partition with -partition.
35
36 ARGUMENTS
37
38    -server         names a file server  machine.    Abbreviated
39                    forms   of  machine  names  may  be  allowed
40                    depending on the naming service available at
41                    the time the command is issued; see page xii
42                    in  the  introductory  About   This   Manual
43                    chapter.  This argument may be combined with
44                    -partition.
45
46    -partition      names a partition.  In addition to the  full
47                    /vicepx  form  of  a  partition  name, three
48                    shorter forms are acceptable; see  page  xii
49                    in   the   introductory  About  This  Manual
50                    chapter.    The  -server  argument  must  be
51                    provided along with this argument.
52
53    -fast           indicates  that  the  output  should display
54                    only the volumeID numbers of all volumes  at
55                    the indicated location.
56
57    -long           indicates that the output should include the
58                    IDs  of  all  volumes  associated  with  the
59                    volume,   the   ReadWrite   volume's  quota,
60                    creation date and  update  date.    See  the
61                    Output section below.
62
63    -quiet          suppresses  the  lines  that  appear  at the
64                    beginning and end of the output, which total
65
66
67
68                    the number of volumes listed.
69
70    -cell           specifies  the  cell  in  which  to  run the
71                    command.  See section 8.3 in  the  Reference
72                    Manual for more details.  -noauth
73                    tells the Volume and Volume Location Servers
74                    to  assign  the  identity  anonymous  to the
75                    issuer.  See section 8.3  in  the  Reference
76                    Manual for more details.  -localauth
77                    constructs a server ticket using a key  from
78                    /usr/afs/etc/KeyFile.    See  section 8.3 in
79                    the  Reference  Manual  for  more   details.
80                    -verbose
81                    tells the Volume and Volume Location Servers
82                    to  report  on  what  they are doing as they
83                    execute the command.  See section 8.3 in the
84                    Reference Manual for more details.  -help
85                    prints the online help for this command.  Do
86                    not  provide  any  other  arguments or flags
87                    with this one.    See  section  8.3  in  the
88                    Reference Manual for more details.
89
90 OUTPUT
91
92    By  default,  the  output  puts  the volumes in alphabetical
93    order by name and lists for each volume:
94
95       - the volume name.
96
97       - the volumeID number.
98
99       - the type (possible values: RW  for  ReadWrite,  RO
100         for ReadOnly and BK for Backup).
101
102       - the current size in Kbytes.
103
104       - the status at the server.  The possible values are
105         On-line,  Off-line  and  needs salvage.    On-line
106         indicates  that  the volume is accessible, whereas
107         the other two indicate a possible problem with the
108         volume.    See section 8.2 in the Reference Manual
109         for further details.
110
111    The first line of the output tells how many  volumes  appear
112    in  the  listing,  and  the  last line how many of those are
113    on-line, off-line and busy.  These lines do  not  appear  if
114    the -quiet flag is used.
115
116    If the -fast flag is added, the output lists only the volume
117    ID number of each volume, arranged in  increasing  numerical
118    order, and omits the last line.
119
120    If  the  -long flag is added, the output includes all of the
121    information in the default listing and  adds  the  following
122    for each volume.
123
124       - the site (file server machine and partition)
125
126       - the  Parent  (ReadWrite),  Clone  (ReleaseClone or
127         Backup) and Backup volume IDs associated with  the
128         volume.    One  should  match the regular volumeID
129
130
131
132         number.  See section 8.2 in the  Reference  Manual
133         for  a  more  complete  explanation.   the maximum
134         quota  allotted  to  the  ReadWrite  copy  of  the
135         volume, in kilobytes
136
137       - the  creation  date.    If  the  volume  has  been
138         restored         with          backup diskrestore,
139         backup volrestore  or  vos   restore,  this is the
140         restore time.
141
142       - the update date, when the contents of this  volume
143         last  changed.    For ReadOnly and Backup volumes,
144         this should match the creation date.
145
146       - the number of times the volume has  been  accessed
147         since the later of
148
149            * 12:00 a.m. on the day the command is issued
150
151            * the last time the volume changed location
152
153         An access is defined as a fetch or store operation
154         on any file system object stored in the volume.
155
156 EXAMPLES
157
158    The following shows selected parts of  the  default  listing
159    for the /vicepb partition on fs2.transarc.com.
160
161        % vos listvol fs2.transarc.com b
162        Total number of volumes on server fs2.transarc.com
163                                      \ partition /vicepb :
164        sys                   1969534847 RW       1582 K On-
165        sys.backup            1969535105 BK       1582 K On-
166              .                    .     .         .   .
167              .                    .     .         .   .
168        user.pat              1969534536 RW      17518 K On-
169        user.pat.backup       1969534538 BK      17537 K On-
170        Total volumes onLine 66 ; Total volumes offLine 0 ;
171                                                   Total bus
172
173    The following shows the output when the -fast flag is added.
174
175        % vos listvol fs2.transarc.com b -fast
176        Total number of volumes on server fs2.transarc.com
177                                        partition /vicepb :
178         1969516782
179         1969516784
180             .
181             .
182         1969535796
183        Total volumes onLine 66 ; Total volumes offLine 0 ;
184                                                   Total bus
185
186
187
188    The following shows two volumes from the output that appears
189    when the -long flag is added.
190
191        % vos listvol fs2.transarc.com b -long
192        Total number of volumes on server fs2.transarc.com
193                                      \ partition /vicepb :
194              .                   .      .         .   .
195              .                   .      .         .   .
196        user.pat              1969534536 RW      17518 K On-
197             fs2.transarc.com /vicepb
198             Parent 1969534536 Clone 0          Backup 19695
199             MaxQuota      20000 K
200             Creation    Mon Jun 12 09:02:25 1989
201             Last Update Thu Jan  4 17:39:34 1990
202             1573 accesses in the past day
203        user.pat.backup       1969534538 BK      17537 K On-
204             fs2.transarc.com /vicepb
205             Parent 1969534536 Clone 0          Backup 19695
206             MaxQuota      20000 K
207             Creation    Fri Jan  5 06:37:59 1990
208             Last Update Fri Jan  5 06:37:59 1990
209             0 accesses in the past day
210               .                   .      .         .   .
211               .                   .      .         .   .
212        Total volumes onLine 66 ; Total volumes offLine 0 ;
213                                                   Total bus
214
215 PRIVILEGE REQUIRED
216
217    None.
218
219 MORE INFORMATION
220
221    backup diskrestore
222
223    backup volrestore
224
225    vos examine vos listvldb vos restore