File: virt-filesystems.pod

package info (click to toggle)
guestfs-tools 1.52.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 69,236 kB
  • sloc: ansic: 15,698; ml: 15,621; sh: 7,396; xml: 5,478; makefile: 3,601; perl: 1,535; lex: 135; yacc: 128; python: 80
file content (325 lines) | stat: -rw-r--r-- 13,026 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325

=head1 名前

virt-filesystems - 仮想マシンまたはディスクイメージにあるファイルシステム、パーティション、ブロックデバイスおよび LVM の一覧表示

=head1 書式

 virt-filesystems [--options] -d domname

 virt-filesystems [--options] -a disk.img [-a disk.img ...]

=head1 説明

This tool allows you to discover filesystems, partitions, logical volumes, and their sizes in a disk image or virtual machine.  It is a replacement for L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>.

One use for this tool is from shell scripts to iterate over all filesystems from a disk image:

 for fs in $(virt-filesystems -a disk.img); do
   # ...
 done

他の使用方法は、これらのパーティションを変更するために (L<virt-resize(1)> のような) 他のツールを使用する前に、パーティションを一覧表示することです。未知のディスクイメージが含んでいるものについてわからなければ、L<virt-inspector(1)> とともにこのツールを使用します。

さまざまなコマンドラインオプションがこのプログラムが表示するものを制御します。それぞれディスクイメージまたは libvirt 仮想マシンを指定するには I<-a> または I<-d> オプションを与える必要があります。単にそれを指定すると、見つけたファイルシステムを 1 行ごとに 1 つずつこのように表示します:

 $ virt-filesystems -a disk.img
 /dev/sda1
 /dev/vg_guest/lv_root

I<-l> または I<--long> を追加すると、追加の情報が出力に含まれます:

 $ virt-filesystems -a disk.img -l
 名前                   種類         VFS   ラベル 容量
 /dev/sda1              filesystem   ext4  boot   524288000
 /dev/vg_guest/lv_root  filesystem   ext4  root   10212081664

I<--extra> を追加すると、マウント不可能な(swap や未知の)ファイルシステムも同様に表示されます:

 $ virt-filesystems -a disk.img --extra
 /dev/sda1
 /dev/vg_guest/lv_root
 /dev/vg_guest/lv_swap
 /dev/vg_guest/lv_data

I<--partitions> を追加すると、ファイルシステムの代わりにパーティションが表示されます:

 $ virt-filesystems -a disk.img --partitions
 /dev/sda1
 /dev/sda2

同様に、それらの項目を一覧表示するには I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>, I<--block-devices> を使用できます。

You can use these options in combination as well (if you want a combination including filesystems, you have to add I<--filesystems>).  Notice that some items fall into several categories (eg. F</dev/sda1> might be both a partition and a filesystem).  These items are listed several times.  To get a list which includes absolutely everything that virt-filesystems knows about, use the I<--all> option.

UUIDs (because they are quite long) are not shown by default.  Add the I<--uuid> option to display device and filesystem UUIDs in the long output.

I<--all --long --uuid> is a useful combination to display all possible information about everything.

 $ virt-filesystems -a win.img --all --long --uuid -h
 Name      Type       VFS  Label           Size Parent   UUID
 /dev/sda1 filesystem ntfs System Reserved 100M -        F81C92571C92112C
 /dev/sda2 filesystem ntfs -               20G  -        F2E8996AE8992E3B
 /dev/sda1 partition  -    -               100M /dev/sda -
 /dev/sda2 partition  -    -               20G  /dev/sda -
 /dev/sda  device     -    -               20G  -        -

マシン読み込み可能な出力のために、カンマ区切り値を取得するために I<--csv> を使用します。

=head1 オプション

=over 4

=item B<--help>

簡単なヘルプを表示します。

=item B<-a> file

=item B<--add> file

Add I<file> which should be a disk image from a virtual machine.  If the virtual machine has multiple block devices, you must supply all of them with separate I<-a> options.

ディスクイメージの形式は自動検知されます。 これを上書きして強制的に特定の形式を使用する場合、 I<--format=..> オプションを使用します。

=item B<-a URI>

=item B<--add URI>

リモートディスクを追加します。 L<guestfish(1)/リモートストレージの追加> 参照。

=item B<--all>

すべてを表示します。これは現在これらのオプションを指定するのと同じです: I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>。(将来この一覧にさらに追加されるかもしれません。)

I<--long> 参照。

=item B<--blkdevs>

=item B<--block-devices>

ブロックデバイスを表示します。

__INCLUDE:blocksize-option.pod__

=item B<-c> URI

=item B<--connect> URI

libvirt を使用していると、指定された I<URI> に接続します。  省略すると、デフォルトの libvirt ハイパーバイザーに接続します。

ゲストのブロックデバイスを直接指定していると((I<-a>))、libvirt は何も使用されません。

=item B<--csv>

Write out the results in CSV format (comma-separated values).  This format can be imported easily into databases and spreadsheets, but read L</NOTE ABOUT CSV FORMAT> below.

=item B<-d> guest

=item B<--domain> guest

名前付きの libvirt 仮想マシンからすべてのディスクを追加します。  名前の代わりに仮想マシンの UUID を使用できます。

=item B<--echo-keys>

キーやパスフレーズを入力するとき、通常 virt-filesystems はエコーを無効化します。 そのため、入力内容を確認できません。 テンペスト攻撃の心配がなく、 部屋に誰も居なければ、 入力内容を確認するためにこのフラグを指定できます。

=item B<--extra>

This causes filesystems that are not ordinary, mountable filesystems to be displayed.  This category includes swapspace, and filesystems that are empty or contain unknown data.

このオプションは I<--filesystems> を意味します。

=item B<--filesystems>

マウント可能なファイルシステムを表示します。表示オプションが選択されていなければ、このオプションが暗に指定されます。

I<--extra> を用いると、マウントできないファイルシステムも表示されます。

=item B<--format=raw|qcow2|..>

=item B<--format>

I<-a> オプションは標準状態でディスクイメージの形式を自動検知します。 これを使用することにより、コマンドラインで後続の I<-a> オプションのディスク形式を強制的に指定できます。 引数なしで I<--format> を使用することにより、 後続の I<-a> オプションに対して自動検知に戻せます。

例:

 virt-filesystems --format=raw -a disk.img

forces raw format (no auto-detection) for F<disk.img>.

 virt-filesystems --format=raw -a disk.img --format -a another.img

forces raw format (no auto-detection) for F<disk.img> and reverts to auto-detection for F<another.img>.

仮想マシンのディスクイメージが信頼できない raw 形式である場合、 ディスク形式を指定するためにこのオプションを使用すべきです。 これにより、悪意のある仮想マシンにより起こり得る セキュリティ問題を回避できます (CVE-2010-3851)。

=item B<-h>

=item B<--human-readable>

I<--long> モードでは、読みやすい形式で容量を表示します。

__INCLUDE:keys-from-stdin-option.pod__

=item B<-l>

=item B<--long>

Display extra columns of data ("long format").

A title row is added unless you also specify I<--no-title>.

The extra columns displayed depend on what output you select, and the ordering of columns may change in future versions.  Use the title row, I<--csv> output and/or L<csvtool(1)> to match columns to data in external programs.

Use I<-h> if you want sizes to be displayed in human-readable format.  The default is to show raw numbers of I<bytes>.

UUID も表示するには I<--uuid> を使用します。

=item B<--lvs>

=item B<--logvols>

=item B<--logical-volumes>

LVM 論理ボリュームを表示します。  このモードでは、論理ボリュームが含むファイルシステムにかかわりなく表示します。

=item B<--no-title>

In I<--long> mode, don’t add a title row.

Note that the order of the columns is not fixed, and may change in future versions of virt-filesystems, so using this option may give you unexpected surprises.

=item B<--parts>

=item B<--partitions>

パーティションを表示します。  このモードでは、パーティションが含むファイルシステムにかかわりなく表示します。

=item B<--pvs>

=item B<--physvols>

=item B<--physical-volumes>

LVM 物理ボリュームを表示します。

=item B<--uuid>

=item B<--uuids>

I<--long> モードでは UUID も表示されます。

=item B<-v>

=item B<--verbose>

デバッグ用の冗長なメッセージを有効にします。

=item B<-V>

=item B<--version>

バージョン番号を表示して、終了します。

=item B<--vgs>

=item B<--volgroups>

=item B<--volume-groups>

LVM ボリュームグループを表示します。

=item B<-x>

libguestfs API 呼び出しのトレースを有効にします。

=back

=head1 列

出力にある列はこのツールの将来のバージョンにおいて並び替えられる場合や変更される場合があることに注意してください。

=over 4

=item B<名前>

ファイルシステム、パーティション、ブロックデバイスまたは LVM の名前。

For device and partition names these are displayed as canonical libguestfs names, so that for example F</dev/sda2> is the second partition on the first device.

I<--long> オプションが指定されてB<いない>と、名前の列のみが出力に表示されます。

=item B<種類>

対象の形式。たとえば、C<filesystem>, C<lv>, C<device> など。

=item B<VFS>

ファイルシステムがあれば、この列は最初に検知されたファイルシステムの形式を表示します。例: C<ext4>。

=item B<ラベル>

(ファイルシステムの識別とマウントのために使用される)ラベルがオブジェクトにあれば、この列はラベルを含みます。

=item B<MBR>

パーティション形式のバイト、2 桁の 16 進数として表示されます。パーティション形式の完全な一覧は次のところにあります: L<http://www.win.tue.nl/~aeb/partitions/partition_types-1.html>

これは DOS (MBR) パーティションに対してのみ適用できます。

=item B<容量>

オブジェクトのバイト単位の容量。I<--human> オプションが使用されていると、容量が人間可読な形式で表示されます。

=item B<親>

親カラムはオブジェクト間の親子関係を記録します。

たとえば、オブジェクトがパーティションならば、このカラムは含んでいるデバイスの名前が含まれます。オブジェクトが論理ボリュームならば、このカラムはボリュームグループの名前です。

複数の親があると、この列は (内部に列を持つ) カンマ区切りの一覧になります。例: C</dev/sda,/dev/sdb>。

=item B<UUID>

If the object has a UUID (used for identifying and mounting filesystems and block devices) then this column contains the UUID as a string.

I<--uuid> オプションが指定されると、 UUID のみが表示されます。

=back

=head1 CSV 形式に関する注意

Comma-separated values (CSV) is a deceptive format.  It I<seems> like it should be easy to parse, but it is definitely not easy to parse.

神話: ただコンマで項目を区切る。 真実: これは正しく動き I<ません>。この例は 2 つの列があります:

 "foo,bar",baz

神話: 同時にファイルの 1 行を読み込みます。 真実: これは正しく動き I<ません>。この例は 1 つの行があります:

 "foo
 bar",baz

For shell scripts, use C<csvtool> (L<https://github.com/Chris00/ocaml-csv> also packaged in major Linux distributions).

For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl or Python’s built-in csv library).

Most spreadsheets and databases can import CSV directly.

=head1 終了ステータス

このプログラムは、成功すると 0 を、エラーがあると 0 以外を返します。

=head1 関連項目

L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-drivers(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://libguestfs.org/>.

=head1 著者

Richard W.M. Jones L<http://people.redhat.com/~rjones/>

=head1 COPYRIGHT

Copyright (C) 2010-2023 Red Hat Inc.