6.119. ホスト
ホストを管理するサービス。
| 名前 | 概要 |
|---|---|
|
| 新しいホストを作成します。 |
|
| 利用可能なすべてのホストのリストを取得します。 |
6.119.1. add POST
新しいホストを作成します。
ホストは、host パラメーターの属性に基づいて作成されます。name、address、および root_password プロパティーが必要です。
たとえば、ホストを追加するには、次のリクエストを送信します。
POST /ovirt-engine/api/hosts
リクエスト本文は、以下のようになります。
<host> <name>myhost</name> <address>myhost.example.com</address> <root_password>myrootpassword</root_password> </host>
root_password 要素は、クライアントが提供する初期表現にのみ含まれ、後続の要求から返される表現には公開されません。
エンジンのバージョン 4.1.2 以降、ホストが新しく追加されると、デフォルトでホストのファイアウォール定義がオーバーライドされるようになりました。
ホスト型エンジンホストを追加するには、オプションの deploy_hosted_engine パラメーターを使用します。
POST /ovirt-engine/api/hosts?deploy_hosted_engine=true
クラスターに、自動デプロイメントがサポートされているデフォルトの外部ネットワークプロバイダーがある場合、ホストの追加時に外部ネットワークプロバイダーがデプロイされます。自動デプロイメントでは、OVN の外部ネットワークプロバイダーのみがサポートされます。クラスターで定義されているもの以外の外部ネットワークプロバイダーをデプロイするには、ホストを追加するときに以下のリクエストを送信して、外部ネットワークプロバイダーを上書きします。
POST /ovirt-engine/api/hosts
external_network_provider_configuration に必要なプロバイダーへの参照が含まれるリクエスト本文:
<host>
<name>myhost</name>
<address>myhost.example.com</address>
<root_password>123456</root_password>
<external_network_provider_configurations>
<external_network_provider_configuration>
<external_network_provider name="ovirt-provider-ovn"/>
</external_network_provider_configuration>
</external_network_provider_configurations>
</host>| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In |
| |
|
| In |
| |
|
| In/Out | 新しいホストが作成されるホスト定義がパラメーターとして渡され、新しく作成されたホストが返されます。 | |
|
| In | インストールに成功した後にホストを再起動するかどうかを示します。 | |
|
| In |
|
6.119.1.1. activate
true に設定すると、このホストはインストールの完了後にアクティブになります。false に設定すると、ホストはインストール後も maintenance ステータスのままになります。このパラメーターがない場合は true と解釈されます。これは、望ましいデフォルトの動作がインストール後にホストをアクティブ化するからです。
6.119.1.2. deploy_hosted_engine
true に設定すると、このホストはホスト型エンジンコンポーネントをデプロイします。欠落している値は true として扱われます。つまり、ホスト型エンジンコンポーネントをデプロイします。このパラメーターを省略すると false になり、ホストはホスト型エンジン領域で操作を実行しません。
6.119.1.3. reboot
インストールに成功した後にホストを再起動するかどうかを示します。デフォルト値は true です。
6.119.1.4. undeploy_hosted_engine
true に設定すると、このホストはホスト型エンジンコンポーネントをアンデプロイし、高可用性クラスターの一部として機能しません。欠落した値は true、すなわちアンデプロイとして扱われます。このパラメーターを省略すると false になり、ホストはホスト型エンジン領域で操作を実行しません。
6.119.2. list GET
利用可能なすべてのホストのリストを取得します。
たとえば、ホストを一覧表示するには、次のリクエストを送信します。
GET /ovirt-engine/api/hosts
応答本文は次のようになります。
<hosts>
<host href="/ovirt-engine/api/hosts/123" id="123">
...
</host>
<host href="/ovirt-engine/api/hosts/456" id="456">
...
</host>
...
</host>
返されるホストのリストの順序は、sortby 句が search パラメーターに含まれている場合にのみ保証されます。
| 名前 | タイプ | 方向 | 概要 |
|---|---|---|---|
|
| In | ホストのすべての属性を応答に含める必要があるかどうかを示します。 | |
|
| In |
| |
|
| In |
このパラメーターを | |
|
| In | ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。 | |
|
| In | たどる 必要のある内部リンクを指定します。 | |
|
| Out | ||
|
| In | 返すホストの最大数を設定します。 | |
|
| In | 仮想マシン ID のコンマ区切りリストを受け入れ、これらの仮想マシンを移行できるホストを返します。 | |
|
| In | 返されたホストを制限するために使用されるクエリー文字列。 |
6.119.2.1. all_content
ホストのすべての属性を応答に含める必要があるかどうかを示します。
デフォルトでは、以下のホスト属性が除外されます。
-
hosted_engine
たとえば、ホストの完全な表現を取得するには、以下を実行します。
GET /ovirt-engine/api/hosts?all_content=true
これらの属性は、取得後にパフォーマンスに影響を及ぼすため、デフォルトでは含まれていません。これらはめったに使用されず、データベースへの追加のクエリーを必要とします。このパラメーターは、特に必要な場合にのみ注意して使用してください。
6.119.2.2. case_sensitive
search パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。デフォルト値は true です。つまり、大文字と小文字の区別が考慮されます。ケースを無視する場合は、false に設定します。
6.119.2.3. check_vms_in_affinity_closure
このパラメーターを migration_target_of とともに使用して、リストされた仮想マシン、およびリストされた仮想マシンとの親和性を強化している他のすべての仮想マシンの有効な移行ターゲットを取得できます。
これは、仮想マシンがポジティブアフィニティーグループ内の他のマシンと一緒に移行される場合に役立ちます。
デフォルト値は false です。
GET /ovirt-engine/api/hosts?migration_target_of=123,456&check_vms_in_affinity_closure=true
6.119.2.4. follow
たどる 必要のある内部リンクを指定します。これらのリンクで参照されるオブジェクトは、現在の要求の一部としてフェッチされます。詳細は、こちら を参照してください。
6.119.2.5. max
返すホストの最大数を設定します。指定されていない場合は、すべてのホストが返されます。
6.119.2.6. migration_target_of
仮想マシン ID のコンマ区切りリストを受け入れ、これらの仮想マシンを移行できるホストを返します。
たとえば、ID 123 の仮想マシンと ID 456 の仮想マシンの移行先ホストの一覧を取得するには、以下のリクエストを送信します。
GET /ovirt-engine/api/hosts?migration_target_of=123,456
