7.2. Virtctl クライアントコマンド

virtctl クライアントは、OpenShift Virtualization リソースを管理するためのコマンドラインユーティリティーです。

virtctl コマンドの一覧を表示するには、以下のコマンドを実行します。

$ virtctl help

特定のコマンドで使用できるオプションの一覧を表示するには、- h または --help フラグを指定して実行します。以下は例になります。

$ virtctl image-upload -h

virtctl コマンドで使用できるグローバルコマンドオプションの一覧を表示するには、以下のコマンドを実行します。

$ virtctl options

以下の表には、OpenShift Virtualization のドキュメント全体で使用されている virtctl コマンドが記載されています。

表7.1 virtctl クライアントコマンド

コマンド説明

virtctl start <vm_name>

仮想マシンを起動します。

virtctl stop <vm_name>

仮想マシンを停止します。

virtctl pause vm|vmi <object_name>

仮想マシンまたは仮想マシンインスタンスを一時停止します。マシンの状態がメモリーに保持されます。

virtctl unpause vm|vmi <object_name>

仮想マシンまたは仮想マシンインスタンスの一時停止を解除します。

virtctl migrate <vm_name>

仮想マシンを移行します。

virtctl restart <vm_name>

仮想マシンを再起動します。

virtctl expose <vm_name>

仮想マシンまたは仮想マシンインスタンスの指定されたポートを転送するサービスを作成し、このサービスをノードの指定されたポートで公開します。

virtctl console <vmi_name>

仮想マシンインスタンスのシリアルコンソールに接続します。

virtctl vnc --kubeconfig=$KUBECONFIG <vmi_name>

VNC (仮想ネットワーククライアント) の仮想マシンインスタンスへの接続を開きます。ローカルマシンでリモートビューアーを必要とする VNC を使用して仮想マシンインスタンスのグラフィカルコンソールにアクセスします。

virtctl vnc --kubeconfig=$KUBECONFIG --proxy-only=true <vmi-name>

VNC 接続からビューアーを使用してポート番号を表示し、仮想マシンインスタンスに手動で接続します。

virtctl vnc --kubeconfig=$KUBECONFIG --port=<port-number> <vmi-name>

ポートが利用可能な場合、その指定されたポートでプロキシーを実行するためにポート番号を指定します。ポート番号が指定されていない場合、プロキシーはランダムポートで実行されます。

virtctl image-upload dv <datavolume_name> --image-path=</path/to/image> --no-create

仮想マシンイメージをすでに存在するデータボリュームにアップロードします。

virtctl image-upload dv <datavolume_name> --size=<datavolume_size> --image-path=</path/to/image>

仮想マシンイメージを新規データボリューム にアップロードします。

virtctl version

クライアントおよびサーバーのバージョン情報を表示します。

virtctl help

virtctl コマンドの説明的な一覧を表示します。

virtctl fslist <vmi_name>

ゲストマシンで利用可能なファイルシステムの詳細な一覧を返します。

virtctl guestosinfo <vmi_name>

オペレーティングシステムに関するゲストエージェント情報を返します。

virtctl userlist <vmi_name>

ゲストマシンでログインしているユーザーの詳細な一覧を返します。