6.253. Vm
| 名前 | 概要 |
|---|---|
|
| VM に自動 CPU および NUMA 設定を適用します。 |
|
| この操作は、別の物理ホストへの仮想マシンの移行を停止します。 |
|
| |
|
| 仮想マシンをプレビューされたスナップショットの状態に永続的に復元します。 |
|
| プールから仮想マシンをデタッチします。 |
|
| 仮想マシンをエクスポートします。 |
|
| 仮想マシンのファイルシステムをフリーズします。 |
|
| 仮想マシンの説明を取得します。 |
|
| 外部コンソールから仮想マシンにアクセスするための自動ユーザーログオンを開始します。 |
|
| ホスト型エンジン仮想マシンのグローバルメンテナンスモードを設定します。 |
|
| 仮想マシンを別の物理ホストに移行します。 |
|
| 仮想マシンをスナップショットの状態に一時的に復元します。 |
|
| 仮想マシンに再起動リクエストを送信します。 |
|
| アタッチされている仮想ディスクを含む仮想マシンを削除します。 |
|
| |
|
| 仮想マシンにリセットリクエストを送信します。 |
|
| VM の現在の状態のスクリーンショットをキャプチャーします。 |
|
| この操作は、シャットダウンリクエストを仮想マシンに送信します。 |
|
| 仮想マシンを起動します。 |
|
| この操作により、仮想マシンの電源が強制的にオフになります。 |
|
| この操作により、仮想マシンの状態がディスクに保存され、停止されます。 |
|
| 仮想マシンのファイルシステムを解凍します。 |
|
| 仮想マシンのディスプレイにアクセスするための時間制約のある認証トークンを生成します。 |
|
| スナップショットをプレビューする前の状態に仮想マシンを復元します。 |
|
| 指定された仮想マシン ID のシステム内の仮想マシンを更新します。 |
6.253.1. autopincpuandnumanodes POST
VM に自動 CPU および NUMA 設定を適用します。
エンジンのバージョン 4.5 以降、この操作は非推奨になり、後方互換性のためにのみ保持されます。これは今後削除されます。代わりに、PUT に続いて 更新操作 を使用してください。
リクエストの例:
POST /ovirt-engine/api/vms/123/autopincpuandnumanodes
リクエスト本文は以下のようになります。
<action> <optimize_cpu_settings>true</optimize_cpu_settings> </action>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | デタッチアクションを非同期で実行する必要があるかどうかを示します。 | |
|
| In | 自動 CPU および NUMA 設定を適用する方法を指定します。 |
6.253.1.1. optimize_cpu_settings
自動 CPU および NUMA 設定を適用する方法を指定します。true に設定すると、VM 固定ホストハードウェアに適合するように CPU トポロジーが調整されます。それ以外の場合は、VM CPU トポロジーが使用されます。
6.253.2. cancelmigration POST
この操作は、別の物理ホストへの仮想マシンの移行を停止します。
POST /ovirt-engine/api/vms/123/cancelmigration
cancel migration アクションは、アクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。
<action/>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | 移行を非同期的にキャンセルする必要があるかどうかを示します。 |
6.253.3. clone POST
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | クローンを非同期で実行するかどうかを示します。 | |
|
| In |
スナップショットを折りたたんで仮想マシンのクローンを作成する必要がある場合は、 | |
|
| In | 仮想マシンディスクのコピー先のストレージドメイン。 | |
|
| In |
6.253.3.1. discard_snapshots
スナップショットを折りたたんで仮想マシンのクローンを作成する必要がある場合は、discard_snapshots パラメーターを使用します。デフォルトは true です。
6.253.4. commitsnapshot POST
仮想マシンをプレビューされたスナップショットの状態に永続的に復元します。
詳細は、preview_snapshot 操作を参照してください。
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | スナップショットを非同期でコミットする必要があるかどうかを示します。 |
6.253.5. detach POST
プールから仮想マシンをデタッチします。
POST /ovirt-engine/api/vms/123/detach
detach アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。
<action/>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | デタッチアクションを非同期で実行する必要があるかどうかを示します。 |
6.253.6. export POST
仮想マシンをエクスポートします。
仮想マシンは、エクスポートドメインにエクスポートできます。たとえば、仮想マシン 123 をエクスポートドメイン myexport にエクスポートするには、以下を実行します。
POST /ovirt-engine/api/vms/123/export
リクエスト本文は以下のようになります。
<action>
<storage_domain>
<name>myexport</name>
</storage_domain>
<exclusive>true</exclusive>
<discard_snapshots>true</discard_snapshots>
</action>
エンジンのバージョン 4.2 以降、仮想マシンを仮想アプライアンス (OVA) としてエクスポートすることもできます。たとえば、仮想マシン 123 を、ホスト myhost のディレクトリー /home/ovirt/ に配置される myvm.ova という名前の OVA ファイルとしてエクスポートするには、次のようにします。
POST /ovirt-engine/api/vms/123/export
リクエスト本文は以下のようになります。
<action>
<host>
<name>myhost</name>
</host>
<directory>/home/ovirt</directory>
<filename>myvm.ova</filename>
</action>エクスポート操作が完了したことを確認してから、エクスポートドメインで何らかの操作を試みます。
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | エクスポートを非同期で実行する必要があるかどうかを示します。 | |
|
| In |
すべてのスナップショットを折りたたんで仮想マシンをエクスポートする必要がある場合は、 | |
|
| In |
| |
|
| In | 仮想マシンをエクスポートする (エクスポート) ストレージドメイン。 |
6.253.7. freezefilesystems POST
仮想マシンのファイルシステムをフリーズします。
この操作は、実行中の仮想マシンのライブスナップショットを作成するときに、QEMU ゲストエージェントを使用して仮想マシンのファイルシステムをフリーズします。通常、これはマネージャーによって自動的に行われますが、OpenStack Volume (Cinder) ディスクを使用する仮想マシンでは API を使用して手動で実行する必要があります。
例:
POST /ovirt-engine/api/vms/123/freezefilesystems
<action/>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | フリーズを非同期で実行する必要があるかどうかを示します。 |
6.253.8. get GET
仮想マシンの説明を取得します。
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | 仮想マシンのすべての属性を応答に含める必要があるかどうかを示します。 | |
|
| In | ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。 | |
|
| In | たどる 必要のある内部リンクを指定します。 | |
|
| In | 返された結果が現在実行中の仮想マシンを記述しているか、それとも既に実行されているが仮想マシンが再起動された場合にのみ有効になる変更を含む仮想マシンを記述しているかを示します。 | |
|
| In | 結果が、その VM の OVA ファイルに表示されるように OVF を公開する必要があるかどうかを示します。 | |
|
| Out | 仮想マシンの説明。 |
6.253.8.1. all_content
仮想マシンのすべての属性を応答に含める必要があるかどうかを示します。
デフォルトでは、以下の属性が除外されます。
-
console -
initialization.configuration.data- 仮想マシンを説明する OVF ドキュメント。 -
rng_source -
soundcard -
virtio-scsi
たとえば、仮想マシン '123' の完全な表現を取得するには、以下を実行します。
GET /ovirt-engine/api/vms/123?all_content=true
これらの属性はパフォーマンスを低下させるため、デフォルトでは含まれていません。これらの属性はめったに使用されず、データベースへの追加のクエリーを必要とします。このパラメーターは、パフォーマンスが低下するため、必要な場合にのみ使用してください。
6.253.8.2. follow
たどる 必要のある内部リンクを指定します。これらのリンクで参照されるオブジェクトは、現在の要求の一部としてフェッチされます。詳細は、こちら を参照してください。
6.253.8.3. next_run
返された結果が現在実行中の仮想マシンを記述しているか、それとも既に実行されているが仮想マシンが再起動された場合にのみ有効になる変更を含む仮想マシンを記述しているかを示します。デフォルト値は false です。
パラメーターがリクエストに含まれているが値がない場合、値は true であると見なされます。以下のリクエストは、
GET /vms/{vm:id};next_run
値 true を使用することと同等です。
GET /vms/{vm:id};next_run=true6.253.8.4. ovf_as_ova
結果が、その VM の OVA ファイルに表示されるように OVF を公開する必要があるかどうかを示します。仮想マシンを記述する OVF ドキュメント。このパラメーターは、all_content=True が設定されている場合にのみ機能します。OVF は initialization.configuration.data に提示されます。
以下はその例です。
GET /vms/{vm:id}?all_content=true&ovf_as_ova=true6.253.9. logon POST
外部コンソールから仮想マシンにアクセスするための自動ユーザーログオンを開始します。
このアクションには、ovirt-guest-agent-gdm-plugin および ovirt-guest-agent-pam-module パッケージがインストールされ、ovirt-guest-agent サービスが仮想マシンで実行されている必要があります。
ユーザーが外部コンソールから仮想マシンにアクセスするには、仮想マシンに対する適切なユーザー権限が必要です。
以下はその例です。
POST /ovirt-engine/api/vms/123/logon
リクエスト本文:
<action/>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | ログオンを非同期で実行する必要があるかどうかを示します。 |
6.253.10. maintenance POST
ホスト型エンジン仮想マシンのグローバルメンテナンスモードを設定します。
このアクションは、他の仮想マシンには影響しません。
例:
POST /ovirt-engine/api/vms/123/maintenance
<action> <maintenance_enabled>true<maintenance_enabled/> </action>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | グローバルメンテナンスアクションを非同期で実行する必要があるかどうかを示します。 | |
|
| In | グローバルメンテナンスを有効にするか無効にするかを示します。 |
6.253.11. migrate POST
仮想マシンを別の物理ホストに移行します。
例:
POST /ovirt-engine/api/vms/123/migrate
仮想マシンの移行先のホストを指定するには、以下を実行します。
<action> <host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/> </action>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | 移行を非同期的に実行するかどうかを指定します。 | |
|
| In | 仮想マシンの移行先のクラスターを指定します。 | |
|
| In | 仮想マシンが移行不可として定義されている場合でも、仮想マシンを移行する必要があることを指定します。 | |
|
| In | 仮想マシンの移行先となる特定のホストを指定します。 | |
|
| In | 同じホスト上で実行されている、この仮想マシンとのポジティブな適用アフィニティーグループ内の他のすべての仮想マシンも移行します。 |
6.253.11.1. cluster
仮想マシンの移行先のクラスターを指定します。これはオプションのパラメーターです。デフォルトでは、仮想マシンは同じクラスター内の別のホストに移行されます。
別のクラスターへのライブマイグレーションはサポートされていません。移行を試みる前に、ターゲットクラスターのハードウェアアーキテクチャーとネットワークアーキテクチャーを十分に検討してください。
6.253.11.2. force
仮想マシンが移行不可として定義されている場合でも、仮想マシンを移行する必要があることを指定します。これはオプションのパラメーターです。デフォルトでは false に設定されます。
6.253.11.3. ホスト
仮想マシンの移行先となる特定のホストを指定します。これはオプションのパラメーターです。デフォルトでは、Red Hat Virtualization Manager は移行用のデフォルトホストを同じクラスター内から自動的に選択します。API ユーザーが特定のホストを必要とする場合、ユーザーは id または name パラメーターを使用してホストを指定できます。
6.253.11.4. migrate_vms_in_affinity_closure
同じホスト上で実行されている、この仮想マシンとのポジティブな適用アフィニティーグループ内の他のすべての仮想マシンも移行します。
デフォルト値は false です。
6.253.12. previewsnapshot POST
仮想マシンをスナップショットの状態に一時的に復元します。
スナップショットは、snapshot.id パラメーターで示されます。内容を確認できるように、一時的に復元されます。検査が完了すると、仮想マシンの状態を commit_snapshot メソッドを使用して永続的にするか、undo_snapshot メソッドを使用して破棄できます。
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | プレビューを非同期で実行する必要があるかどうかを示します。 | |
|
| In | スナップショットのプレビューに含まれるディスクを指定します。 | |
|
| In | スナップショットのプレビューで使用するリースストレージドメイン ID を指定します。 | |
|
| In | ||
|
| In | ||
|
| In |
6.253.12.1. disks
スナップショットのプレビューに含まれるディスクを指定します。
ディスクパラメーターごとに、その image_id も指定する必要があります。
たとえば、識別子が 111 で、その image_id が 222 のディスクを含む識別子 456 のスナップショットをプレビューするには、次のようなリクエストを送信します。
POST /ovirt-engine/api/vms/123/previewsnapshot
リクエスト本文:
<action>
<disks>
<disk id="111">
<image_id>222</image_id>
</disk>
</disks>
<snapshot id="456"/>
</action>6.253.12.2. lease
スナップショットのプレビューで使用するリースストレージドメイン ID を指定します。リースパラメーターが渡されない場合、プレビューされたスナップショットリースストレージドメインが使用されます。ストレージドメインパラメーターが空のリースパラメーターが渡された場合、スナップショットプレビューにリースは使用されません。リースパラメーターがストレージドメインパラメーターと共に渡された場合、仮想マシンスナップショットの 1 つに属するリースドメイン ID の 1 つだけをストレージドメイン ID にすることができます。これはオプションのパラメーターで、デフォルトは null に設定されています
6.253.13. reboot POST
仮想マシンに再起動リクエストを送信します。
以下はその例です。
POST /ovirt-engine/api/vms/123/reboot
reboot アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。
<action/>
バックアップが実行されている場合でも仮想マシンを再起動するには、アクションに force 要素を含める必要があります。
たとえば、仮想マシン 123 を強制的に再起動するには、以下を実行します。
POST /ovirt-engine/api/vms/123/reboot
<action>
<force>true</force>
</action>| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | 再起動を非同期で実行する必要があるかどうかを示します。 | |
|
| In | 仮想マシンのバックアップが実行されている場合でも、仮想マシンを強制的に再起動する必要があるかどうかを示します。 |
6.253.14. remove DELETE
アタッチされている仮想ディスクを含む仮想マシンを削除します。
たとえば、識別子が 123 の仮想マシンを削除するには、以下を実行します。
DELETE /ovirt-engine/api/vms/123
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | 削除を非同期的に実行するかどうかを指定します。 | |
|
| In | アタッチされた仮想ディスクを削除する代わりに、最初にデタッチして保持する必要があるかどうかを示しています。 | |
|
| In | 仮想マシンを強制的に削除する必要があるかどうかを示します。 |
6.253.14.1. force
仮想マシンを強制的に削除する必要があるかどうかを示します。
ロックされた仮想マシンおよびロックされたディスクイメージを持つ仮想マシンは、このフラグを true に設定しないと削除できません。
6.253.15. reordermacaddresses POST
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | アクションを非同期で実行する必要があるかどうかを示します。 |
6.253.16. reset POST
仮想マシンにリセットリクエストを送信します。
以下はその例です。
POST /ovirt-engine/api/vms/123/reset
reset アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。
<action/>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | リセットを非同期で実行する必要があるかどうかを示します。 |
6.253.17. screenshot POST
VM の現在の状態のスクリーンショットをキャプチャーします。
以下はその例です。
POST /ovirt-engine/api/vms/123/screenshot
screenshot アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。
<action/>
6.253.18. shutdown POST
この操作は、シャットダウンリクエストを仮想マシンに送信します。
以下はその例です。
POST /ovirt-engine/api/vms/123/shutdown
shutdown アクションはアクション固有のパラメーターを取らないので、リクエスト本文は空の action を含む必要があります。
<action/>
バックアップが実行されている場合でも仮想マシンをシャットダウンするには、アクションに force 要素を含める必要があります。
たとえば、仮想マシン 123 を強制的にシャットダウンするには、以下を実行します。
POST /ovirt-engine/api/vms/123/shutdown
<action>
<force>true</force>
</action>| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | シャットダウンを非同期で実行する必要があるかどうかを示します。 | |
|
| In | バックアップが実行されている場合でも、仮想マシンを強制的にシャットダウンする必要があるかどうかを示します。 | |
|
| In | 仮想マシンが停止した理由。 |
6.253.18.1. reason
仮想マシンが停止した理由。オプションで、仮想マシンをシャットダウンするときにユーザーが設定します。
6.253.19. start POST
仮想マシンを起動します。
仮想環境が完成し、機能するために必要なすべてのコンポーネントが仮想マシンに含まれている場合は、仮想マシンを起動できます。
この例では、仮想マシンを起動します。
POST /ovirt-engine/api/vms/123/start
リクエスト本文は以下のようになります。
<action/>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | 起動アクションを非同期で実行する必要があるかどうかを示します。 | |
|
| In | ||
|
| In | ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。 | |
|
| In |
| |
|
| In |
| |
|
| In |
| |
|
| In |
| |
|
| In |
| |
|
| In | この特定の実行のための仮想マシンの定義。 | |
|
| In | ゲストが開始した再起動の場合でも、この実行設定が破棄されることを示します。 |
6.253.19.1. pause
true に設定されている場合、仮想マシンを一時停止モードで起動します。デフォルトは false です。
6.253.19.2. use_cloud_init
true に設定すると、初期化タイプは cloud-init に設定されます。デフォルト値は false です。詳細には、cloud-init のドキュメント を参照してください。
6.253.19.3. use_ignition
true に設定すると、初期化タイプは Ignition に設定されます。デフォルト値は false です。詳細は、Ignition のドキュメント を参照してください。
6.253.19.4. use_initialization
true に設定すると、初期化タイプは VM の OS によって設定されます。Windows は Sysprep に、Linux は cloud-init に、RedHat CoreOS は Ignition に設定されます。いずれかの初期化タイプが明示的に設定されている場合 (useCloudInit、useSysprep、または useIgnition)、それらが優先され、このフラグは無視されます。デフォルト値は false です。
6.253.19.5. use_sysprep
true に設定すると、初期化タイプは Sysprep に設定されます。デフォルト値は false です。詳細については、Sysprep を参照してください。
6.253.19.6. vm
この特定の実行のための仮想マシンの定義。
以下はその例です。
<action>
<vm>
<os>
<boot>
<devices>
<device>cdrom</device>
</devices>
</boot>
</os>
</vm>
</action>これにより、この特定の起動に対してのみブートデバイスが CDROM に設定されます。仮想マシンの電源がオフになると、この定義は元に戻ります。
6.253.19.7. volatile
ゲストが開始した再起動の場合でも、この実行設定が破棄されることを示します。デフォルト値は false です。
6.253.20. stop POST
この操作により、仮想マシンの電源が強制的にオフになります。
以下はその例です。
POST /ovirt-engine/api/vms/123/stop
stop アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。
<action/>
バックアップが実行されている場合でも仮想マシンを停止するには、アクションに force 要素を含める必要があります。
たとえば、仮想マシン 123 を強制的に停止するには、以下を実行します。
POST /ovirt-engine/api/vms/123/stop
<action>
<force>true</force>
</action>| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | stop アクションを非同期で実行する必要があるかどうかを示します。 | |
|
| In | バックアップが実行されている場合でも、仮想マシンを強制的に停止する必要があるかどうかを示します。 | |
|
| In | 仮想マシンが停止した理由。 |
6.253.20.1. reason
仮想マシンが停止した理由。オプションで、仮想マシンをシャットダウンするときにユーザーが設定します。
6.253.21. suspend POST
この操作により、仮想マシンの状態がディスクに保存され、停止されます。停止された仮想マシンを起動し、起動アクションで仮想マシンの状態を復元します。
以下はその例です。
POST /ovirt-engine/api/vms/123/suspend
suspend アクションはアクション固有のパラメーターを取らないので、リクエスト本文は空の action を含む必要があります。
<action/>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | suspend アクションを非同期で実行する必要があるかどうかを示します。 |
6.253.22. thawfilesystems POST
仮想マシンのファイルシステムを解凍します。
この操作は、実行中の仮想マシンのライブスナップショットを作成するときに、QEMU ゲストエージェントを使用して仮想マシンのファイルシステムを解凍します。通常、これはマネージャーによって自動的に行われますが、OpenStack Volume (Cinder) ディスクを使用する仮想マシンでは API を使用して手動で実行する必要があります。
例:
POST /api/vms/123/thawfilesystems
<action/>
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | ファイルシステムの解凍アクションを非同期で実行する必要があるかどうかを示します。 |
6.253.23. ticket POST
仮想マシンのディスプレイにアクセスするための時間制約のある認証トークンを生成します。
以下はその例です。
POST /ovirt-engine/api/vms/123/ticket
クライアント指定のアクションには、必要に応じて、必要なチケット値および/または有効期限 (秒単位) が含まれます。
応答は、使用された実際のチケットの値と有効期限を指定します。
<action>
<ticket>
<value>abcd12345</value>
<expiry>120</expiry>
</ticket>
</action>仮想マシンが 1 つのグラフィックスプロトコルのみをサポートするように設定されている場合、生成された認証トークンはそのプロトコルに対して有効になります。ただし、仮想マシンが複数のプロトコル (VNC と SPICE) をサポートするように設定されている場合、認証トークンは SPICE プロトコルに対してのみ有効になります。
VNC など特定のプロトコルの認証トークンを取得するには、仮想マシンのグラフィックスコンソールを管理する サービス の ticket メソッドを使用して、リクエストを送信します。
POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | チケットの生成を非同期で実行する必要があるかどうかを示します。 | |
|
| In/Out |
6.253.24. undosnapshot POST
スナップショットをプレビューする前の状態に仮想マシンを復元します。
詳細は、preview_snapshot 操作を参照してください。
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | スナップショットをもとに戻すアクションを非同期で実行する必要があるかどうかを示します。 |
6.253.25. update PUT
指定された仮想マシン ID のシステム内の仮想マシンを更新します。
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | 更新を非同期的に実行するかどうかを指定します。 | |
|
| In | 更新を仮想マシンにすぐに適用するか、仮想マシンの再起動時にのみ適用するかを示します。 | |
|
| In/Out |
6.253.25.1. next_run
更新を仮想マシンにすぐに適用するか、仮想マシンの再起動時にのみ適用するかを示します。デフォルト値は false で、デフォルトでは変更が即座に適用されます。
