Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

6.286. Vms

Expand
表6.895 メソッドの概要
名前Summary

add

新しい仮想マシンを作成します。

list

システムの仮想マシンのリストを返します。

6.286.1. add POST
リンクのコピー

新しい仮想マシンを作成します。

仮想マシンはさまざまな方法で作成できます。

  • テンプレートから。この場合、テンプレートの識別子または名前を指定する必要があります。たとえば、プレーンシェルスクリプトと XML を使用すると、次のようになります。 
#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."
curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--data '
<vm>
  <name>myvm</name>
  <template>
    <name>Blank</name>
  </template>
  <cluster>
    <name>mycluster</name>
  </cluster>
</vm>
' \
"${url}/vms"
Copy to Clipboard Toggle word wrap
  • スナップショットから。この場合、スナップショットの識別子を指定する必要があります。たとえば、プレーンシェルスクリプトと XML を使用すると、次のようになります。 
#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."
curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request POST \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--data '
<vm>
  <name>myvm</name>
  <snapshots>
    <snapshot id="266742a5-6a65-483c-816d-d2ce49746680"/>
  </snapshots>
  <cluster>
    <name>mycluster</name>
  </cluster>
</vm>
' \
"${url}/vms"
Copy to Clipboard Toggle word wrap

テンプレートまたはスナップショットから仮想マシンを作成する場合、通常は、仮想マシンのディスクを作成するストレージドメインを明示的に指定すると便利です。仮想マシンがテンプレートから作成された場合、マッピングを示す一連の disk_attachment 要素を渡すことで、これを行うことができます。 

<vm>
  ...
  <disk_attachments>
    <disk_attachment>
      <disk id="8d4bd566-6c86-4592-a4a7-912dbf93c298">
        <storage_domains>
          <storage_domain id="9cb6cb0a-cf1d-41c2-92ca-5a6d665649c9"/>
        </storage_domains>
      </disk>
    <disk_attachment>
  </disk_attachments>
</vm>
Copy to Clipboard Toggle word wrap

仮想マシンがスナップショットから作成された場合、この一連のディスクは少し異なり、id の代わりに image_id 属性を使用します。 

<vm>
  ...
  <disk_attachments>
    <disk_attachment>
      <disk>
        <image_id>8d4bd566-6c86-4592-a4a7-912dbf93c298</image_id>
        <storage_domains>
          <storage_domain id="9cb6cb0a-cf1d-41c2-92ca-5a6d665649c9"/>
        </storage_domains>
      </disk>
    <disk_attachment>
  </disk_attachments>
</vm>
Copy to Clipboard Toggle word wrap

XML 記述で追加の仮想マシンパラメーターを指定することができます。たとえば、2 GiB の RAM を備えた desktop タイプの仮想マシンでは、次のようなリクエスト本文を送信することで記述を追加できます。 

<vm>
  <name>myvm</name>
  <description>My Desktop Virtual Machine</description>
  <type>desktop</type>
  <memory>2147483648</memory>
  ...
</vm>
Copy to Clipboard Toggle word wrap

起動可能な CDROM デバイスは、次のように設定できます。 

<vm>
  ...
  <os>
    <boot dev="cdrom"/>
  </os>
</vm>
Copy to Clipboard Toggle word wrap

CDROM から起動するには、CDROM サービス で説明されているように、まずディスクを挿入する必要があります。次に、os.boot.devices 属性を使用して、その CDROM からの起動を指定できます。 

<vm>
  ...
  <os>
    <boot>
      <devices>
        <device>cdrom</device>
      </devices>
    </boot>
  </os>
</vm>
Copy to Clipboard Toggle word wrap

いずれの場合も、仮想マシンが作成されるクラスターの名前または識別子は必須です。

Expand
表6.896 パラメーターの概要
名前型方向Summary

auto_pinning_policy

AutoPinningPolicy

In

自動 CPU および NUMA 設定を適用するかどうか、およびその適用方法を指定します。

clone

ブール値

In

仮想マシンをテンプレートから独立させる必要があるかどうかを指定します。

clone_permissions

ブール値

In

テンプレートの権限を仮想マシンにコピーするかどうかを指定します。

filter

ブール値

In

管理者ユーザーにのみ関連しています。

seal

ブール値

In

作成後に仮想マシンをシールするかどうかを指定します。

vm

Vm

In/Out

 

6.286.1.1. auto_pinning_policy
リンクのコピー

自動 CPU および NUMA 設定を適用するかどうか、およびその適用方法を指定します。

重要

エンジンのバージョン 4.5 以降、この操作は非推奨になり、後方互換性のためにのみ保持されます。これは今後削除されます。代わりに、POST に続いて 追加操作 を使用してください。

リクエストの例: 

POST /ovirt-engine/api/vms?auto_pinning_policy=existing/adjust
Copy to Clipboard Toggle word wrap

リクエスト本文は以下のようになります。 

<vm>
  <name>myvm<name>
  <template>
    <name>mytemplate<name>
  </template>
  <cluster>
    <name>mycluster<name>
  </cluster>
  <placement_policy>
    <hosts>
      <host>
        <name>myhost</name>
      </host>
    </hosts>
  </placement_policy>
</vm>
Copy to Clipboard Toggle word wrap

6.286.1.2. clone
リンクのコピー

仮想マシンをテンプレートから独立させる必要があるかどうかを指定します。

仮想マシンがテンプレートからデフォルトで作成される場合、仮想マシンのディスクはテンプレートのディスクに依存し、copy on write メカニズムを使用して、テンプレートとの違いだけが実際のストレージスペースを使用するようにします。このパラメーターが指定され、値が true の場合、作成された仮想マシンのディスクは 複製 され、テンプレートとは無関係になります。たとえば、独立した仮想マシンを作成するには、次のようなリクエストを送信します。 

POST /ovirt-engine/vms?clone=true
Copy to Clipboard Toggle word wrap

リクエスト本文は以下のようになります。 

<vm>
  <name>myvm<name>
  <template>
    <name>mytemplate<name>
  </template>
  <cluster>
    <name>mycluster<name>
  </cluster>
</vm>
Copy to Clipboard Toggle word wrap
注記

このパラメーターが true の場合、clone_permissions=true を使用する場合と同様に、テンプレートのパーミッションもコピーされます。

6.286.1.3. clone_permissions
リンクのコピー

テンプレートの権限を仮想マシンにコピーするかどうかを指定します。

このオプションのパラメーターが指定され、その値が true の場合、テンプレートのパーミッション (継承されたものではなく、直接のパーミッションのみ) が作成された仮想マシンにコピーされます。たとえば、mytemplate テンプレートから仮想マシンを作成し、そのパーミッションをコピーするには、次のようなリクエストを送信します。 

POST /ovirt-engine/api/vms?clone_permissions=true
Copy to Clipboard Toggle word wrap

リクエスト本文は以下のようになります。 

<vm>
  <name>myvm<name>
  <template>
    <name>mytemplate<name>
  </template>
  <cluster>
    <name>mycluster<name>
  </cluster>
</vm>
Copy to Clipboard Toggle word wrap

6.286.1.4. filter
リンクのコピー

管理者ユーザーにのみ関連しています。作成された仮想マシンでこのユーザーに UserVmManager ロールを割り当てるかどうかを示します。これにより、ユーザーは後で管理者権限を放棄して (filter=true を指定することにより)、非管理者ユーザーであるかのように仮想マシンにアクセスできるようになります。

注記

既存の仮想マシンに対する admin-as-user (filter=true を指定) POST リクエストは、以前に管理者がユーザーとして (filter=true を使用して) 作成した仮想マシン以外では失敗します。

6.286.1.5. seal
リンクのコピー

作成後に仮想マシンをシールするかどうかを指定します。

このオプションのパラメーターが指定され、その値が true の場合、仮想マシンは作成後にシールされます。値が 'false' の場合、仮想マシンはシールされません。パラメーターが提供されていない場合、仮想マシンは、シールされたテンプレートから作成され、そしてゲスト OS が Windows に設定されていない場合にのみ、シールされます。

たとえば、mytemplate テンプレートから仮想マシンを作成してシールするには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/vms?seal=true
Copy to Clipboard Toggle word wrap

リクエスト本文は以下のようになります。 

<vm>
  <name>myvm<name>
  <template>
    <name>mytemplate<name>
  </template>
  <cluster>
    <name>mycluster<name>
  </cluster>
</vm>
Copy to Clipboard Toggle word wrap

6.286.2. list GET
リンクのコピー

システムの仮想マシンのリストを返します。

返される仮想マシンのリストの順序は、sortby 句が search パラメーターに含まれている場合にのみ保証されます。

Expand
表6.897 パラメーターの概要
名前型方向Summary

all_content

ブール値

In

仮想マシンのすべての属性を応答に含める必要があるかどうかを示します。

case_sensitive

ブール値

In

search パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。

filter

ブール値

In

ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。

follow

String

In

たどる 必要のある内部リンクを指定します。

max

Integer

In

返すことのできる結果の最大数。

ovf_as_ova

ブール値

In

結果が、その VM の OVA ファイルに表示されるように OVF を公開する必要があるかどうかを示します。

search

String

In

返される仮想マシンを制限するために使用されるクエリー文字列。

vms

Vm[]

Out

 

6.286.2.1. all_content
リンクのコピー

仮想マシンのすべての属性を応答に含める必要があるかどうかを示します。

デフォルトでは、以下の属性が除外されます。

  • console
  • initialization.configuration.data - 仮想マシンを説明する OVF ドキュメント。
  • rng_source
  • soundcard
  • virtio_scsi

たとえば、仮想マシンの完全な表現を取得するには、次のようなリクエストを送信します。 

GET /ovirt-engine/api/vms?all_content=true
Copy to Clipboard Toggle word wrap
注記

これらの属性を含めない理由はパフォーマンスです。ほとんど使用されず、データベースへの追加のクエリーが必要です。そのため、本当に必要な場合にのみ、このパラメーターを使用するようにしてください。

6.286.2.2. case_sensitive
リンクのコピー

search パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。デフォルト値は true です。つまり、大文字と小文字の区別が考慮されます。ケースを無視する場合は、false に設定します。

6.286.2.3. follow
リンクのコピー

たどる 必要のある内部リンクを指定します。これらのリンクで参照されるオブジェクトは、現在の要求の一部としてフェッチされます。詳細は、こちら を参照してください。

6.286.2.4. ovf_as_ova
リンクのコピー

結果が、その VM の OVA ファイルに表示されるように OVF を公開する必要があるかどうかを示します。仮想マシンを記述する OVF ドキュメント。このパラメーターは、all_content=True が設定されている場合にのみ機能します。OVF は initialization.configuration.data に提示されます。

以下に例を示します。 

GET /vms?all_content=true&ovf_as_ova=true
Copy to Clipboard Toggle word wrap
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat