virt-edit(1)

名前
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. "ID" can be either the libguestfs device name, or the UUID of the LUKS device.

    --key "ID":key:KEY_STRING
        Use the specified "KEY_STRING" as passphrase.

    --key "ID":file:FILENAME
        Read the passphrase from FILENAME.

--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 がファイルシステムを誤検知している場合、 これは有用です。

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

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

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

旧形式のコマンドライン引数
前のバージョンの 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 を実行している場合に限り:

•   Drive letter prefixes like "C:" are resolved against the Windows Registry to the correct filesystem.

•   Any backslash ("\") characters in the path are replaced with forward slashes so that libguestfs can process it.

•   The path is resolved case insensitively to locate the file that should be edited.

There are some known shortcomings:

•   Some NTFS symbolic links may not be followed correctly.

•   NTFS junction points that cross filesystems are not followed.

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-2020 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:

•   The version of libguestfs.

•   Where you got libguestfs (eg. which Linux distro, compiled from source, etc)

•   Describe the bug accurately and give a way to reproduce it.

•   Run libguestfs-test-tool(1) and paste the complete, unedited output into the bug report.