Manpages

名 前

virt-edit - 仮 想 マ シ ン の フ ァ イ ル の 編 集

書 式

virt-edit [--options] -d domname file [file ...]
virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]
virt-edit [-d domname|-a disk.img] file -e 'expr' 古 い 形 式 :

virt-edit domname file
virt-edit disk.img [disk.img ...] file

説 明

"virt-edit" は 名 前 付 き の 仮 想 マ シ ン （ ま た は デ ィ ス ク イ メ ー ジ ） に あ る 、 そ れ ぞ れ の "フ ァ イ ル " を 編 集 す る た め の コ マ ン ド ラ イ ン ツ ー ル で す 。 複 数 の フ ァ イ ル 名 を 指 定 で き ま す 。 そ の 場 合 、 そ れ ぞ れ 順 番 に 編 集 さ れ ま す 。 各 フ ァ イ ル 名 は ル ー ト デ ィ レ ク ト リ ー か ら 始 ま る （ つ ま り ’/’ か ら 始 ま る ） 完 全 パ ス で あ る 必 要 が あ り ま す 。 単 に フ ァ イ ル を 表 示 し た い だ け な ら ば 、 virt-cat(1) を 使 用 し て く だ さ い 。 よ り 複 雑 な 場 合 に 対 し て は guestfish(1) ツ ー ル を 参 照 し て く だ さ い （ 以 下 の "guestfish の 使 用 法 " 参 照 ） 。

"virt-edit" は 新 し い フ ァ イ ル を 作 成 す る た め に 使 用 で き ま せ ん 。 guestfish(1) は こ の こ と や さ ら に い ろ い ろ な こ と が で き ま す 。

例

名 前 付 き の フ ァ イ ル を 対 話 的 に 編 集 し ま す :

virt-edit -d mydomain /boot/grub/grub.conf
virt-edit -d mydomain /etc/passwd

Windows 仮 想 マ シ ン に 対 し て は 、 Windows の パ ス が 解 釈 さ れ ま す :

virt-edit -d mywindomain 'c:\autoexec.bat'

Perl が イ ン ス ト ー ル さ れ て い る と 、 非 対 話 的 に フ ァ イ ル を 編 集 す る こ と も で き ま す （ 以 下 の "非 対 話 的 な 編 集 方 法 " 参 照 ） 。 init の 初 期 ラ ン ベ ル を 5 に 変 更 す る に は :

virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'

オ プ シ ョ ン

--help 簡 単 な ヘ ル プ を 表 示 し ま す 。
-a file
--add file

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

-a URI
--add URI リ モ ー ト デ ィ ス ク を 追 加 し ま す 。 "リ モ ー ト ス ト レ ー ジ の 追 加 " in guestfish(1) 参 照 。
-b EXTENSION
--backup EXTENSION 仮 想 マ シ ン の デ ィ ス ク イ メ ー ジ に あ る 元 の フ ァ イ ル の バ ッ ク ア ッ プ を 作 成 し ま す 。 バ ッ ク ア ッ プ は 元 の フ ァ イ ル 名 に "extension" を 加 え た も の に な り ま す 。 一 般 的 に "extension" の 最 初 の 文 字 は ド ッ ト "." で す 。 そ の た め 次 の よ う に 書 き ま す :

virt-edit -b .orig [etc] 初 期 設 定 で は 、 バ ッ ク ア ッ プ フ ァ イ ル は 作 成 さ れ ま せ ん 。

--blocksize=512
--blocksize=4096
--blocksize

This parameter sets the sector size of the disk image. It affects all explicitly added subsequent disks after this parameter. Using --blocksize with no argument switches the disk sector size to the default value which is usually 512 bytes. See also "guestfs_add_drive_opts" in guestfs(3).

-c URI
--connect URI

libvirt を 使 用 し て い る と 、 指 定 さ れ た URI に 接 続 し ま す 。 省 略 す る と 、 デ フ ォ ル ト の libvirt ハ イ パ ー バ イ ザ ー に 接 続 し ま す 。 仮 想 マ シ ン の ブ ロ ッ ク デ バ イ ス を 直 接 指 定 す る と 、 libvirt は ま っ た く 使 用 さ れ ま せ ん 。

-d GUEST
--domain GUEST 名 前 付 き の libvirt 仮 想 マ シ ン か ら す べ て の デ ィ ス ク を 追 加 し ま す 。 名 前 の 代 わ り に 仮 想 マ シ ン の UUID を 使 用 で き ま す 。
--echo-keys キ ー や パ ス フ レ ー ズ を 入 力 す る と き 、 通 常 virt-edit は エ コ ー を 無 効 化 し ま す 。 そ の た め 、 入 力 内 容 を 確 認 で き ま せ ん 。 テ ン ペ ス ト 攻 撃 の 心 配 が な く 、 部 屋 に 誰 も 居 な け れ ば 、 入 力 内 容 を 確 認 す る た め に こ の フ ラ グ を 指 定 で き ま す 。
-e EXPR
--edit EXPR
--expr EXPR 外 部 エ デ ィ タ ー を 起 動 す る 代 わ り に 、 フ ァ イ ル に あ る 各 行 に 対 し て 非 対 話 的 に Perl 表 現 "EXPR" を 適 用 し ま す 。 以 下 の "非 対 話 的 な 編 集 方 法 " を 参 照 し て く だ さ い 。 表 現 が シ ェ ル に よ り 変 更 さ れ る の を 防 ぐ た め に 、 適 切 に 引 用 符 で く く る よ う 注 意 し て く だ さ い 。 こ の オ プ シ ョ ン は Perl 5 が イ ン ス ト ー ル さ れ て い る と き の み 利 用 可 能 で あ る こ と に 注 意 し て く だ さ い 。
--format=raw|qcow2|..
--format

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

virt-edit --format=raw -a disk.img file

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

virt-edit --format=raw -a disk.img --format -a another.img file

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

--key SELECTOR

Specify a key for LUKS, to automatically open a LUKS device when using the inspection.
--key NAME:key:KEY_STRING
--key UUID:key:KEY_STRING
--key all:key:KEY_STRING

"NAME" is the libguestfs device name (eg. "/dev/sda1"). "UUID" is the device UUID. "all" means try the key against any encrypted device.

Use the specified "KEY_STRING" as passphrase.

--key NAME:file:FILENAME
--key UUID:file:FILENAME
--key all:file:FILENAME

Read the passphrase from FILENAME.

--key NAME:clevis
--key UUID:clevis
--key all:clevis

Attempt passphrase-less unlocking for the device with Clevis, over the network. Please refer to "ENCRYPTED DISKS" in guestfs(3) for more information on network-bound disk encryption (NBDE).

Note that if any such option is present on the command line, QEMU user networking will be automatically enabled for the libguestfs appliance.

--keys-from-stdin

Read key or passphrase parameters from stdin. The default is to try to read passphrases from the user by opening /dev/tty.

If there are multiple encrypted devices then you may need to supply multiple keys on stdin, one per line.

-m dev[:mountpoint[:options[:fstype]]]
--mount dev[:mountpoint[:options[:fstype]]] 指 定 さ れ た マ ウ ン ト ポ イ ン ト に あ る 、 名 前 付 き パ ー テ ィ シ ョ ン ま た は 論 理 ボ リ ュ ー ム を マ ウ ン ト し ま す 。

If the mountpoint is omitted, it defaults to /.

Specifying any mountpoint disables the inspection of the guest and the mount of its root and all of its mountpoints, so make sure to mount all the mountpoints needed to work with the filenames given as arguments.

If you don’t know what filesystems a disk image contains, you can either run guestfish without this option, then list the partitions, filesystems and LVs available (see "list-partitions", "list-filesystems" and "lvs" commands), or you can use the virt-filesystems(1) program. マ ウ ン ト パ ラ メ ー タ ー の 三 番 目 の (ほ と ん ど 使 用 さ れ な い ) 項 目 は 、 バ ッ ク エ ン ド の フ ァ イ ル シ ス テ ム を マ ウ ン ト す る た め に 使 用 さ れ る マ ウ ン ト オ プ シ ョ ン の 一 覧 で す 。 こ れ が 指 定 さ れ て い な い 場 合 、 マ ウ ン ト オ プ シ ョ ン は 空 文 字 列 ま た は "ro" (--ro フ ラ グ が 使 用 さ れ て い る 場 合 ) に な り ま す 。

-m /dev/sda1:/:acl,user_xattr こ の フ ラ グ を 使 用 す る こ と は 、 "mount-options" コ マ ン ド を 使 用 す る こ と と 同 等 で す 。 パ ラ メ ー タ ー の 四 番 目 の 項 目 は 使 用 す る フ ァ イ ル シ ス テ ム ド ラ イ バ ー ("ext3" や "ntfs" な ど ) で す 。 こ れ は ほ と ん ど 必 要 あ り ま せ ん 。 し か し 、 複 数 の ド ラ イ バ ー が フ ァ イ ル シ ス テ ム に 対 し て 有 効 で あ る 場 合 (例 : "ext2" と "ext3")、 ま た は libguestfs が フ ァ イ ル シ ス テ ム を 誤 検 知 し て い る 場 合 、 こ れ は 有 用 で す 。

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

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

旧 形 式 の コ マ ン ド ラ イ ン 引 数

前 の バ ー ジ ョ ン の virt-edit は ど ち ら を 書 く こ と も で き ま す :

virt-edit disk.img [disk.img ...] file ま た は

virt-edit guestname file

whereas in this version you should use -a or -d respectively to avoid the confusing case where a disk image might have the same name as a guest. 互 換 性 の た め 古 い 形 式 が ま だ サ ポ ー ト さ れ て い ま す 。

非 対 話 的 な 編 集 方 法

"virt-edit" normally calls out to $EDITOR (or vi) so the system administrator can interactively edit the file.

There are two ways also to use "virt-edit" from scripts in order to make automated edits to files. (Note that although you can use "virt-edit" like this, it’s less error-prone to write scripts directly using the libguestfs API and Augeas for configuration file editing.)

The first method is to temporarily set $EDITOR to any script or program you want to run. The script is invoked as "$EDITOR tmpfile" and it should update "tmpfile" in place however it likes.

The second method is to use the -e parameter of "virt-edit" to run a short Perl snippet in the style of sed(1). For example to replace all instances of "foo" with "bar" in a file:

virt-edit -d domname filename -e 's/foo/bar/'

The full power of Perl regular expressions can be used (see perlre(1)). For example to delete root’s password you could do:

virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'

What really happens is that the snippet is evaluated as a Perl expression for each line of the file. The line, including the final "\n", is passed in $_ and the expression should update $_ or leave it unchanged.

To delete a line, set $_ to the empty string. For example, to delete the "apache" user account from the password file you can do:

virt-edit -d mydomain /etc/passwd -e '$_ = "" if /^apache:/'

To insert a line, prepend or append it to $_. However appending lines to the end of the file is rather difficult this way since there is no concept of "last line of the file" - your expression just doesn’t get called again. You might want to use the first method (setting $EDITOR) if you want to do this.

The variable $lineno contains the current line number. As is traditional, the first line in the file is number 1.

The return value from the expression is ignored, but the expression may call "die" in order to abort the whole program, leaving the original file untouched.

Remember when matching the end of a line that $_ may contain the final "\n", or (for DOS files) "\r\n", or if the file does not end with a newline then neither of these. Thus to match or substitute some text at the end of a line, use this regular expression:

/some text(\r?\n)?$/

Alternately, use the perl "chomp" function, being careful not to chomp $_ itself (since that would remove all newlines from the file):

my $m = $_; chomp $m; $m =~ /some text$/

Windows の パ ス

"virt-edit" has a limited ability to understand Windows drive letters and paths (eg. E:\foo\bar.txt). 仮 想 マ シ ン が Windows を 実 行 し て い る 場 合 に 限 り :

There are some known shortcomings:

guestfish の 使 用 法

guestfish(1) is a more powerful, lower level tool which you can use when "virt-edit" doesn’t work.

Using "virt-edit" is approximately equivalent to doing:

guestfish --rw -i -d domname edit /file

where "domname" is the name of the libvirt guest, and /file is the full path to the file.

The command above uses libguestfs’s guest inspection feature and so does not work on guests that libguestfs cannot inspect, or on things like arbitrary disk images that don’t contain guests. To edit a file on a disk image directly, use:

guestfish --rw -a disk.img -m /dev/sda1 edit /file

where disk.img is the disk image, /dev/sda1 is the filesystem within the disk image to edit, and /file is the full path to the file.

"virt-edit" は 新 し い フ ァ イ ル を 作 成 で き ま せ ん 。 代 わ り に guestfish コ マ ン ド "touch", "write" ま た は "upload" を 使 用 し て く だ さ い :

guestfish --rw -i -d domname touch /newfile
guestfish --rw -i -d domname write /newfile "new content"
guestfish --rw -i -d domname upload localfile /newfile

環 境 変 数

"EDITOR" 設 定 さ れ て い る と 、 こ の 文 字 列 が エ デ ィ タ ー と し て 使 用 さ れ ま す 。 "emacs -nw" の よ う に 、 引 数 を 含 め る こ と も で き ま す 。 設 定 さ れ て い な い と 、 "vi" が 使 用 さ れ ま す 。

終 了 ス テ ー タ ス

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

関 連 項 目

guestfs(3), guestfish(1), virt-cat(1), virt-copy-in(1), virt-tar-in(1), http://libguestfs.org/, perl(1), perlre(1).

著 者

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

COPYRIGHT

Copyright (C) 2009-2023 Red Hat Inc.

LICENSE

BUGS

To get a list of bugs against libguestfs, use this link: https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools

To report a new bug against libguestfs, use this link: https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools

When reporting a bug, please supply: