vmrun コマンドは、機能のカテゴリに分類されます。
次の表には、Workstation Player の vmrun コマンドとパラメータがそれらの機能に基づいて一覧表示されます。パラメータは 1 行に 1 つリストされます。角括弧で囲まれたパラメータはオプションです。垂直バーはキーワードの選択を示します。
vmrun の電源コマンドとパラメータ
| オプション | パラメータ | 説明 |
|---|---|---|
| start |
|
仮想マシンを起動します。デフォルトの gui オプションはマシンを対話的に起動します。これは Workstation Player インターフェイスを表示するために必要です。nogui オプションは起動ダイアログ ボックスを含む Workstation Player インターフェイスを抑制し、非対話型のスクリプトを可能にします。 |
| stop |
|
仮想マシンを停止します。シャットダウン スクリプトを実行した後でゲストをパワーオフするには soft オプションを使用します。電源ボタンを押した場合のように、スクリプトを実行せずにゲストをパワーオフするには、hard オプションを使用します。デフォルトでは、.vmx ファイル（ある場合）で指定されている powerType 値が使用されます。 |
| reset |
|
仮想マシンをリセットします。ゲストを再起動する前にシャットダウン スクリプトを実行するには soft オプションを使用します。リセット ボタンを押した場合のように、スクリプトを実行せずにゲストを再起動するには、hard オプションを使用します。デフォルトでは、.vmx ファイル（ある場合）で指定されている powerType 値が使用されます。 |
| suspend |
|
仮想マシンをシャットダウンせずにサスペンドし、ローカルでの作業を後で再開できるようにします。soft オプションは、システム スクリプトの実行後にゲストをサスペンドします。Windows ゲストでは、これらのスクリプトは IP アドレスを解放します。Linux ゲストでは、スクリプトはネットワークをサスペンドします。hard オプションは、スクリプトを実行せずにゲストをサスペンドします。デフォルトでは、.vmx ファイル（ある場合）で指定されている powerType 値が使用されます。 suspend コマンドの終了後に仮想マシンの動作を再開するには、start コマンドを使用します。Windows では、IP アドレスが取得されます。Linux では、ネットワークが再起動されます。 |
| pause |
|
仮想マシンを一時停止します。 |
| unpause |
|
通常の操作を一時停止した時点から仮想マシンの操作を再開します。 |
vmrun のスナップショット コマンドとパラメータ
| オプション | パラメータ | 説明 |
|---|---|---|
| listSnapshots |
|
仮想マシン内のすべてのスナップショットを一覧表示します。showtree オプションはスナップショットをツリー形式で表示します。子は親の下にインデントされます。 |
| snapshot |
|
仮想マシンのスナップショットを作成します。Workstation Player は複数のスナップショットをサポートするため、スナップショットの名前を指定する必要があります。 |
| deleteSnapshot |
|
仮想マシンからスナップショットを削除します。 Workstation Player は複数のスナップショットをサポートするため、スナップショットの名前を指定する必要があります。仮想マシンがパワーオフまたはサスペンドの状態である必要があります。スナップショットに子がある場合、それらは削除されたスナップショットの親の子になり、以降のスナップショットがチェーンの終わりからそれまでと同じように続きます。 andDeleteChildren オプションは、指定されたスナップショットとその子を再帰的に削除します。 競合する名前の解決方法については、[revertToSnapshot] を参照してください。 |
| revertToSnapshot |
または
|
仮想マシンをスナップショット作成時の状態に設定します。ただし、スナップショットの作成時に仮想マシンがパワーオンされていた場合、vmrun はその仮想マシンをサスペンドされた状態に戻しますが、仮想マシンの実行は再開しません。 スナップショットの名前が仮想マシン内で一意の場合、仮想マシンの構成ファイルへのパスと一意のスナップショット名を指定してそのスナップショットに戻ります。 複数のスナップショットの名前が同じ場合は、スナップショットの絶対パス名を含めてスナップショットを指定します。パス名は、スラッシュ文字 (/) で区切られた一連のスナップショット名で構成されます。それぞれの名前はツリー内の新しいスナップショットを指定します。たとえば、パス名 Snap1/Snap2 は、Snap1 という名前のスナップショットの状態から取得した Snap2 という名前のスナップショットを識別します。 |
vmrun のホスト ネットワーク コマンドとパラメータ
ホスト ネットワーク コマンドをサポートするのは Workstation Player with Windows だけです。Workstation Player with Linux does not support the host network commands.
| オプション | パラメータ | 説明 |
|---|---|---|
| listHostNetworks | ホスト上のすべてのネットワークを一覧表示します。 |
|
| listPortForwardings |
|
ホスト ネットワーク上の利用可能なすべてのポート転送を一覧表示します。 |
| setPortForwarding |
|
ホスト ネットワーク上のポート転送を設定します。
注： コマンドがエラーを返さないようにするには、
sudo ユーティリティでこのオプションを使用します。たとえば、
sudo vmrun setPortForwarding となります。
|
| deletePortForwarding |
|
ホスト ネットワーク上のポート転送を削除します。
注： コマンドがエラーを返さないようにするには、
sudo ユーティリティでこのオプションを使用します。たとえば、
sudo vmrun deletePortForwarding となります。
|
vmrun ゲスト OS コマンドとパラメータ
VMware Tools の待機時間であるタイムアウトはすべてのゲスト関連コマンドで 5 分です。
| オプション | パラメータ | 説明 |
|---|---|---|
| runProgramInGuest |
|
ゲスト OS で指定したプログラムを実行します。-noWait オプションは、ゲストでプログラムが起動すると、プログラムが終了するのを待つのではなく、すぐにプロンプトを返します。このオプションはインタラクティブなプログラムに対して役に立ちます。-activeWindow オプションを使用すると、Windows GUI は最小化されず画面に表示された状態になります。Linux の場合、このオプションの影響はありません。-interactive オプションはインタラクティブなゲスト ログインを強制します。このオプションは、Windows Vista および Windows 7 以降のゲストでプログラムをコンソール ウィンドウに表示させる場合に役に立ちます。ゲストからアクセス可能なプログラムの絶対パス名を指定する必要があります。また、プログラムの要件に従い、プログラムの引数で指定されたすべてのファイルに対して完全にアクセス可能なパス名を指定します。VMware Tools と有効なゲスト ログインが必要です。 |
| fileExistsInGuest |
|
指定されたファイルがゲスト OS に存在するかを確認します。VMware Tools と有効なゲスト ログインが必要です。 |
| directoryExistsInGuest |
|
指定されたディレクトリがゲスト OS に存在するかを確認します。VMware Tools と有効なゲスト ログインが必要です。 |
| setSharedFolderState |
|
ホストとゲスト仮想マシン間で共有される指定のフォルダの書き込み可能状態を変更します。share name パラメータの値は、ゲスト ファイル システムのマウント ポイントです。path to folder on host パラメータの値は、ホスト上のエクスポートされたディレクトリです。共有フォルダを書き込み可能または読み取り専用にするには、writable または readonly パラメータを含めます。 |
| addSharedFolder |
|
ホストとゲスト間で共有するフォルダを追加します。addSharedFolder オプションを有効にするには、仮想マシンが実行している必要があります。 |
| removeSharedFolder |
|
ホスト上の共有フォルダへのゲスト仮想マシンのアクセスを削除します。removeSharedFolder オプションを有効にするには、仮想マシンが実行している必要があります。 |
| enableSharedFolders |
|
.vmx ファイルで指定されたゲスト仮想マシンがそのホストとの間でフォルダを共有することを許可します。有効にしたら、
addSharedFolder オプションを実行して共有する各ホストのフォルダを指定します。オプションの
[runtime] 引数は、フォルダの共有を仮想マシンがパワーオフされるまでに制限します。指定しないと、設定は次回のパワーオン時にも保持されます。
注：
enableSharedFolders オプションは、ゲストのシャットダウンと再起動後に有効になります。エラー メッセージは表示されません。
|
| disableSharedFolders |
|
.vmx ファイルで指定されたゲスト仮想マシンがそのホストとの間でフォルダを共有しないようにします。オプションの
[runtime] 引数は、フォルダの共有に適用される停止を仮想マシンがパワーオフされるまでに制限します。指定しないと、設定は次回のパワーオン時にも保持されます。
注：
disableSharedFolders オプションは、ゲストのシャットダウンと再起動後に有効になります。エラー メッセージは表示されません。
|
| listProcessesInGuest |
|
ゲスト OS で実行しているすべてのプロセスを一覧表示します。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。 |
| killProcessInGuest |
|
ゲスト OS で指定したプロセスを停止します。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。プロセス ID は、listProcessesInGuest オプションの出力で「pid=」の後にリストされた任意の番号です。 |
| runScriptInGuest |
|
ゲスト OS で指定したコマンド スクリプトを実行します。オプションの説明については、runProgramInGuest エントリを参照してください。interpreter path オプションはスクリプトを実行します。ファイル名ではなく、スクリプトの完全なテキストを指定します。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。 |
| deleteFileInGuest |
|
ゲスト OS から指定したファイルを削除します。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。 |
| createDirectoryInGuest |
|
ゲスト OS に指定したディレクトリを作成します。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。 |
| deleteDirectoryInGuest |
|
ゲスト OS から指定したディレクトリを削除します。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu と -gp オプションを使用してゲストにログインできます。 |
| createTempfileInGuest |
|
ゲスト OS に一時ファイルを作成し、作成された一時ファイルのパス名を返します。パス名は、オペレーティング システムによって異なります。deleteFileInGuest オプションを実行してファイルを削除することができます。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。 |
| listDirectoryInGuest |
|
ゲスト OS に指定したディレクトリの内容を一覧表示します。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。 |
| CopyFileFromHostToGuest |
|
ホストからゲスト OS にファイルをコピーします。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。宛先ファイル名またはゲスト ファイル名の前に、送信元ファイル名またはホスト ファイル名を指定します。 |
| CopyFileFromGuestToHost |
|
ゲスト OS からホストにファイルをコピーします。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。宛先ファイル名またはホスト ファイル名の前に、送信元ファイル名またはゲスト ファイル名を指定します。 |
| renameFileInGuest |
|
ゲスト OS のファイルの名前を変更するか、ファイルを移動します。VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。宛先ファイル名の前に、送信元ファイル名または元のファイル名を指定します。 |
| connectNamedDevice |
|
コマンドで名前が指定されたデバイスをゲスト OS に接続します。このコマンドは、仮想マシンをパワーオンしたときにのみ実行できます。sound、serial0、Ethernet0、sata0:1 などのデバイス名を使用できます。
注：
vmrun connectNamedDevice コマンドを使用して切断されたサウンド デバイスを実行中の仮想マシンに接続した後、仮想マシンをパワーオフすると、仮想マシンの設定にはサウンド デバイスが接続済みとして表示されていても、サウンド デバイスが仮想マシンから切断されることがあります。
|
| disconnectNamedDevice |
|
コマンドで名前が指定されたデバイスをゲスト OS から切断します。このコマンドは、仮想マシンをパワーオンしたときにのみ実行できます。sound、serial0、Ethernet0、sata0:1 などのデバイス名を使用できます。
注：
vmrun disconnectNamedDevice コマンドを使用して接続されたサウンド デバイスを実行中の仮想マシンから切断した後、仮想マシンをパワーオフすると、仮想マシンの設定にはサウンド デバイスが切断済みとして表示されていても、サウンド デバイスが仮想マシンに再接続されることがあります。
|
| captureScreen |
|
仮想マシンの画面をローカル ファイルにキャプチャします。ホスト上で指定した出力ファイルは、PNG 形式です。有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。 |
| writeVariable |
|
変数を仮想マシンの状態またはゲストに書き込みます。.vmx ファイルに保存された非永続的なゲスト変数 guestVar、ランタイム構成変数 runtimeConfig、または環境変数 guestEnv をゲスト OS で設定できます。ゲスト変数はランタイム専用の値で、ランタイムの値をゲストとの間で受け渡しする簡単な方法を提供します。環境変数には VMware Tools と有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。Linux では、ゲスト環境の設定には root ログインも必要です。 |
| readVariable |
|
変数を仮想マシンの状態またはゲストから読み取ります。.vmx ファイルに保存されたゲスト変数、ランタイム設定、または環境変数をゲスト OS で設定できます。guestEnv 変数の読み取りには有効なゲスト ログインが必要です。たとえば、-gu および -gp オプションを使用してゲストにログインできます。変数のタイプの説明については、writeVariable エントリを参照してください。 |
| getGuestIPAddress |
|
ゲストの IP アドレスを取得します。 [ -wait ] オプションを使用すると、コマンドは IP アドレスが利用可能になるまで待機します。たとえば、仮想マシンがパワーオンされるまで IP アドレスは使用できません。ネットワークの準備ができていない場合、コマンドはすぐにコマンドライン プロンプトに戻ります。 |
vmrun の一般的なコマンドとパラメータ
| オプション | パラメータ | 説明 |
|---|---|---|
| list | 実行中のすべての仮想マシンを一覧表示します。 |
|
| upgradevm |
|
仮想マシンを現在の仮想ハードウェアのバージョンにアップグレードします。仮想ハードウェアのバージョンがサポートされる最新バージョンの場合は影響はありません。
|
| installTools |
|
ゲスト OS への VMware Tools のインストールを準備します。自動実行が有効になっている Windows ゲストでは、VMware Tools インストーラ自体が自動的に起動します。自動実行機能のない Linux ゲストの場合は、コマンドによって仮想 CD-ROM ドライブをゲストに適した VMware Tools ISO イメージに接続しますが、インストーラは起動しません。 製品マニュアルに記載された追加の手順を手動で実行し、インストールを完了する必要があります。 |
| checkToolsState |
|
ゲスト内で VMware Tools のステータスを確認します。ステータスには、「不明」、「インストール済み」、および「実行中」があります。 |
| deleteVM |
|
仮想マシンを削除します。 |
| clone |
|
仮想マシンのコピーを作成します。 Workstation Player は、クローン オプションをサポートしていません。 |
vmrun テンプレートの仮想マシン コマンドとパラメータ
| オプション | パラメータ | 説明 |
|---|---|---|
| downloadPhotonVM
|
|
VMware Project Photon オペレーティング システムの仮想マシンをダウンロードします。 |
