6.279. VmPools
仮想マシンプールへの読み取り/書き込みアクセスを提供します。
名前 | Summary |
---|---|
| 新しい仮想マシンプールを作成します。 |
| 使用可能な仮想マシンプールのリストを取得します。 |
6.279.1. add POST
新しい仮想マシンプールを作成します。
新しいプールには、name
、cluster
、template
の属性が必要です。id
または name
のネストされた属性でクラスターとテンプレートを特定します。
POST /ovirt-engine/api/vmpools
以下のボディーを使用します。
<vmpool> <name>mypool</name> <cluster id="123"/> <template id="456"/> </vmpool>
名前 | 型 | 方向 | Summary |
---|---|---|---|
| In/Out | 追加するプール。 | |
| In | プール用に作成された仮想マシンを作成後にシールする必要があるかどうかを指定します。 |
6.279.1.1. seal
プール用に作成された仮想マシンを作成後にシールする必要があるかどうかを指定します。
このオプションのパラメーターが指定され、その値が true
の場合、プール用に作成された仮想マシンは作成後にシールされます。値が 'false' の場合、仮想マシンはシールされません。パラメーターが提供されていない場合、仮想マシンは、シールされたテンプレートから作成され、そしてゲスト OS が Windows に設定されていない場合にのみ、シールされます。このパラメーターは、プールの作成時に作成された仮想マシンにのみ影響します。
たとえば、5 つの仮想マシンを含む仮想マシンプールを作成してそれらをシールするには、以下のようなリクエストを送信します。
POST /ovirt-engine/api/vmpools?seal=true
以下のボディーを使用します。
<vmpool> <name>mypool</name> <cluster id="123"/> <template id="456"/> <size>5</size> </vmpool>
6.279.2. list GET
使用可能な仮想マシンプールのリストを取得します。
GET /ovirt-engine/api/vmpools
以下の応答が返されます。
<vm_pools> <vm_pool id="123"> ... </vm_pool> ... </vm_pools>
返されるプールのリストの順序は、sortby
句が search
パラメーターに含まれている場合にのみ保証されます。
名前 | 型 | 方向 | Summary |
---|---|---|---|
| In |
| |
| In | ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。 | |
| In | たどる 必要のある内部リンクを指定します。 | |
| In | 返すプールの最大数を設定します。 | |
| Out | 取得したプール。 | |
| In | 返されたプールを制限するために使用されるクエリー文字列。 |
6.279.2.1. case_sensitive
search
パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。デフォルト値は true
です。つまり、大文字と小文字の区別が考慮されます。ケースを無視する場合は、false
に設定します。
6.279.2.2. follow
たどる 必要のある内部リンクを指定します。これらのリンクで参照されるオブジェクトは、現在の要求の一部としてフェッチされます。詳細は、こちら を参照してください。
6.279.2.3. max
返すプールの最大数を設定します。この値が指定されていない場合、すべてのプールが返されます。