REST API ガイド

Red Hat Virtualization 4.4

Red Hat Virtualization REST アプリケーションプログラミングインターフェイスの使用

Red Hat Virtualization Documentation Team

rhev-docs@redhat.com

概要

本ガイドでは、Red Hat Virtualization Manager Representational State Transfer アプリケーションプログラミングインターフェイスを説明します。

このガイドは、ovirt-engine-api-model コードにあるドキュメントのコメントから生成されており、現在、未完状態です。このドキュメントの更新バージョンは、新しいコンテンツが利用可能になると公開されます。

第1章はじめに
リンクのコピー

Red Hat Virtualization Manager には、Representational State Transfer (REST) API が含まれています。ソフトウェア開発者やシステム管理者は、この API を使用することで、標準の Web インターフェイス以外で Red Hat Virtualization 環境を制御できるようになります。API は、開発者および管理者が Red Hat Virtualization 環境の機能を標準の Hypertext Transfer Protocol (HTTP) 経由で API にアクセスする外部アプリケーションやカスタムスクリプトと統合する場合に便利です。

API の利点は以下のとおりです。

幅広いクライアントサポート: HTTP プロトコルをサポートする各種プログラミング言語、フレームワークまたはシステムで API を使用できます。
自己記述型: 実行時に多くの詳細が発見されるため、クライアントアプリケーションでは、仮想化インフラストラクチャーの情報は最小限で済みます。
リソースベースのモデル: リソースベースの REST モデルにより仮想化プラットフォームを自然な形で管理することが可能です。

これにより、開発者および管理者は以下のような作業を行うことができます。

エンタープライズ IT システムとの統合
サードパーティーの仮想化ソフトウェアとの統合
自動メンテナンスやエラーチェックなどのタスクの実行
スクリプトを使って、Red Hat Virtualization 環境の反復タスクを自動化します。

このドキュメントは、Red Hat Virtualization API のリファレンスとしてのロールを果たします。本ガイドでは、開発者および管理者を対象に、指定の SDK を使用するか、直接、API を経由して Red Hat Virtualization 環境を利用する方法の手順と実例を記載しています。

1.1. Representational State Transfer
リンクのコピー

Representational State Transfer (REST) は、特定のサービスとその表現に焦点を当てた設計アーキテクチャーです。リソース表現は、情報の主要な抽象化で、サーバー上の特定の 1 つの管理要素に対応します。クライアントは Uniform Resource Identifier (URI) にある server 要素に要求を送信し、GET、POST、PUT、DELETE などの標準の HTTP メソッドで操作を実行します。これにより、クライアントとサーバー間でステートレスに通信が行われ、各要求が他の要求とは独立して機能し、要求完了必要なすべての情報が含まれます。

1.1.1. API の前提条件
リンクのコピー

Red Hat Virtualization API を使用するための前提条件

API を含む Red Hat Virtualization Manager のネットワークインストール。
API サーバーから HTTP 要求を開始および受信するクライアントまたはプログラミングライブラリー。以下に例を示します。
- oVirt Python SDK
- oVirt Java SDK
- cURL コマンドラインツール
- RESTClient (RESTful Web サービスのデバッガー)
HTTP (Hypertext Transfer Protocol) の知識 (REST API の対話に使用されるプロトコル)。RFC 2616: HTTP/1.1 を参照してください。
API がリソース表現の構築に使用する Extensible Markup Language(XML) または JavaScript Object Notation(JSON) の知識。W3C の Extensible Markup Language (XML) 1.0 および ECMA-404: JSON data interchange syntax を参照してください。

第2章認証とセキュリティー
リンクのコピー

2.1. TLS/SSL 証明書
リンクのコピー

Red Hat Virtualization API には、Hypertext Transfer Protocol Secure (HTTPS) 脚注が必要です:[SDK や CLI コンポーネントなどのクライアントソフトウェアと安全にやり取りするためには、RFC 2818: HTTP Over TLS を参照してください。これには、サーバーが使用する CA 証明書を取得して、クライアントの証明書ストアにインポートする必要があります。

2.1.1. CA 証明書の取得
リンクのコピー

Red Hat Virtualization Manager から CA 証明書を取得し、以下のいずれかの方法でクライアントマシンに転送できます。

方法 1

CA 証明書の取得で推奨の方法は、openssl s_client コマンドラインツールを使用してサーバーとの実際の TLS ハンドシェイクを実行し、サーバーが提示する証明書を抽出する方法です。

以下の例のように、openssl s_client コマンドを実行します。

openssl s_client \
-connect myengine.example.com:443 \
-showcerts \
< /dev/null

$ openssl s_client \
-connect myengine.example.com:443 \
-showcerts \
< /dev/null

Copy to Clipboard

Toggle word wrap

出力例

CONNECTED(00000003)
depth=1 C = US, O = Example Inc., CN = myengine.example.com.23416
verify error:num=19:self signed certificate in certificate chain
---
Certificate chain
 0 s:/C=US/O=Example Inc./CN=myengine.example.com
   i:/C=US/O=Example Inc./CN=myengine.example.com.23416
-----BEGIN CERTIFICATE-----
MIIEaTCCA1GgAwIBAgICEAQwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
SVlJe7e5FTEtHJGTAeWWM6dGbsFhip5VXM0gfqg=
-----END CERTIFICATE-----
 1 s:/C=US/O=Example Inc./CN=myengine.example.com.23416
   i:/C=US/O=Example Inc./CN=myengine.example.com.23416
-----BEGIN CERTIFICATE-----
MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
Pkyg1rQHR6ebGQ==
-----END CERTIFICATE-----

CONNECTED(00000003)
depth=1 C = US, O = Example Inc., CN = myengine.example.com.23416
verify error:num=19:self signed certificate in certificate chain
---
Certificate chain
 0 s:/C=US/O=Example Inc./CN=myengine.example.com
   i:/C=US/O=Example Inc./CN=myengine.example.com.23416
-----BEGIN CERTIFICATE-----
MIIEaTCCA1GgAwIBAgICEAQwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
SVlJe7e5FTEtHJGTAeWWM6dGbsFhip5VXM0gfqg=
-----END CERTIFICATE-----
 1 s:/C=US/O=Example Inc./CN=myengine.example.com.23416
   i:/C=US/O=Example Inc./CN=myengine.example.com.23416
-----BEGIN CERTIFICATE-----
MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
Pkyg1rQHR6ebGQ==
-----END CERTIFICATE-----

Copy to Clipboard

Toggle word wrap

-----BEGIN CERTIFICATE----- 行と -----END CERTIFICATE----- 行の間のテキストは、サーバーで提示された証明書が表示されています。

最初の証明書は、サーバー自体の証明書です。2 番目の証明書は、CA の証明書です。

以下の例のように、-----BEGIN CERTIFICATE----- 行と -----END CERTIFICATE----- 行を含む CA 証明書を ca.crt ファイルにコピーします。
```
-----BEGIN CERTIFICATE-----
MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
Pkyg1rQHR6ebGQ==
-----END CERTIFICATE-----
```
```
-----BEGIN CERTIFICATE-----
MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
Pkyg1rQHR6ebGQ==
-----END CERTIFICATE-----
```
Copy to Clipboard Toggle word wrap
重要
これは、サーバーが使用する CA 証明書を取得する最も信頼性の高い方法です。ここで説明されている残りの方法はほとんどの場合に機能しますが、証明書がサーバー管理者によって手動で置き換えられた場合は、正しい CA 証明書を取得することはできません。

方法 2

openssl s_client を使用して証明書を取得できない場合は、curl や wget などのコマンドラインツールを使用して、Red Hat Virtualization Manager から CA 証明書をダウンロードすることができます。curl と wget は複数のプラットフォームで利用できます。

curl を使用している場合:

curl \
--output ca.crt \
'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'

$ curl \
--output ca.crt \
'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'

Copy to Clipboard

Toggle word wrap

wget を使用している場合:

wget \
--output-document ca.crt \
'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'

$ wget \
--output-document ca.crt \
'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'

Copy to Clipboard

Toggle word wrap

方法 3

Web ブラウザーを使用して、`https://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA` にある証明書に移動します。

選択したブラウザーによって、証明書はダウンロードされるか、またはブラウザーのキーストアにインポートされます。

ブラウザーで証明書をダウンロードした場合は、ファイルを ca.crt として保存します。
ブラウザーが証明書をインポートする場合は、ブラウザーの証明書管理オプションを使用してエクスポートし、ca.crt として保存します。

方法 4

Red Hat Virtualization Manager にログインし、トラストストアから証明書をエクスポートして、クライアントマシンにコピーします。

Red Hat Virtualization Manager マシンに root としてログインします。
Java keytool 管理ユーティリティーを使用して、トラストストアから証明書をエクスポートします。
```
keytool \
-keystore /etc/pki/ovirt-engine/.truststore \
-storepass mypass \
-exportcert \
-alias cacert \
-rfc \
-file ca.crt
```
```
# keytool \
-keystore /etc/pki/ovirt-engine/.truststore \
-storepass mypass \
-exportcert \
-alias cacert \
-rfc \
-file ca.crt
```
Copy to Clipboard Toggle word wrap
これにより、ca.crt という名前の証明書ファイルが作成されます。
scp コマンドを使用して、証明書をクライアントマシンにコピーします。
```
scp ca.crt myuser@myclient.example.com:/home/myuser/.
```
```
$ scp ca.crt myuser@myclient.example.com:/home/myuser/.
```
Copy to Clipboard Toggle word wrap
これらの各メソッドにより、クライアントマシンの ca.crt という名前の証明書ファイルが作成されます。次に、このファイルをクライアントの証明書ストアにインポートする必要があります。

2.1.2. クライアントへの証明書のインポート
リンクのコピー

クライアントへの証明書のインポートは、クライアントが証明書を保存し、解釈する方法に依存します。証明書のインポートに関する詳細は、クライアントのドキュメントを参照してください。

2.2. 認証
リンクのコピー

Red Hat Virtualization Manager アカウントを持つユーザーは、API にアクセスできます。すべての要求は、以下で説明するように OAuth または Basic 認証を使用して認証する必要があります。

2.2.1. OAuth 認証
リンクのコピー

Red Hat Virtualization バージョン 4.0 以降、RFC 6749 に説明されているように、推奨の認証メカニズムは OAuth 2.0 です。

OAuth は高性能なプロトコルであり、認可およびアクセストークンを取得するメカニズムがいくつかあります。Red Hat Virtualization API と合わせて使用する場合は、RFC 6749 で説明されているように、Resource Owner Password Credentials Grant (リソース所有者のパスワード認証情報の付与) のみがサポートされます。

最初に トークン を取得し、ユーザー名とパスワードを Red Hat Virtualization Manager のシングルサインオンサービスに送信する必要があります。

POST /ovirt-engine/sso/oauth/token HTTP/1.1
Host: myengine.example.com
Content-Type: application/x-www-form-urlencoded
Accept: application/json

POST /ovirt-engine/sso/oauth/token HTTP/1.1
Host: myengine.example.com
Content-Type: application/x-www-form-urlencoded
Accept: application/json

Copy to Clipboard

Toggle word wrap

リクエスト本文には、grant_type、scope、username、および password パラメーターが含まれている必要があります。

Expand

表2.1 OAuth トークン要求パラメーター
名前	値
`grant_type`	`password`
`scope`	`ovirt-app-api`
`username`	`admin@internal`
`password`	`mypassword`

これらのパラメーターは URL でエンコードされている必要があります。たとえば、ユーザー名の @ 文字を %40 としてエンコードする必要があります。結果のリクエスト本文は以下のようになります。

grant_type=password&scope=ovirt-app-api&username=admin%40internal&password=mypassword

grant_type=password&scope=ovirt-app-api&username=admin%40internal&password=mypassword

Copy to Clipboard

Toggle word wrap

重要

scope パラメーターは OAuth RFC で任意として説明されていますが、Red Hat Virtualization API と併用する場合は必須であり、この値は ovirt-app-api である必要があります。

ユーザー名とパスワードが有効な場合、Red Hat Virtualization Manager のシングルサインオンサービスは、以下のような JSON ドキュメントで応答します。

{
  "access_token": "fqbR1ftzh8wBCviLxJcYuV5oSDI=",
  "token_type": "bearer",
  "scope": "...",
  ...
}

{
  "access_token": "fqbR1ftzh8wBCviLxJcYuV5oSDI=",
  "token_type": "bearer",
  "scope": "...",
  ...
}

Copy to Clipboard

Toggle word wrap

API 認証の目的で、関連する唯一の名前/値のペアは access_token です。これは操作しないでください。SSO サービスが提供するとおりに使用してください。

トークンを取得すると、HTTP Authorization ヘッダーにトークンを追加して、Bearer スキームで API への要求を実行するために使用できます。たとえば、仮想マシンのリストを取得するには、以下のような要求を送信します。

GET /ovirt-engine/api/vms HTTP/1.1
Host: myengine.example.com
Accept: application/xml
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=

GET /ovirt-engine/api/vms HTTP/1.1
Host: myengine.example.com
Accept: application/xml
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=

Copy to Clipboard

Toggle word wrap

トークンは、複数の要求に対して複数回使用できますが、最終的に期限切れになります。期限が切れると、サーバーは 401 HTTP 応答コードで要求を拒否します。

HTTP/1.1 401 Unauthorized

HTTP/1.1 401 Unauthorized

Copy to Clipboard

Toggle word wrap

これが生じる場合は、Red Hat Virtualization Manager のシングルサインオンサービスは現在トークンの更新をサポートしていないため、新しいトークンが必要です。上記と同じ方法を使用して新しいトークンを要求できます。

2.2.2. Basic 認証
リンクのコピー

重要

Basic 認証は後方互換性としてのみサポートされます。Red Hat Virtualization のバージョン 4.0 以降は非推奨となり、今後削除されます。

各要求は、HTTP Basic 認証を使用して ^[1] 認証情報をエンコードします。要求に適切な Authorization ヘッダーが含まれていない場合には、サーバーは 401 Authorization Required 応答を送信します。

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com

HTTP/1.1 401 Authorization Required

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com

HTTP/1.1 401 Authorization Required

Copy to Clipboard

Toggle word wrap

要求は、指定したレルムの Authorization ヘッダーで発行されます。username@domain:password 規則を使用して、提供された認証情報で適切な Red Hat Virtualization Manager ドメインおよびユーザーをエンコードします。

下記の表には、Base64 認証情報をエンコードするためのプロセスをまとめています。

Expand

表2.2 API アクセスの認証情報のエンコーディング
項目	値
ユーザー名	`admin`
ドメイン	`internal`
パスワード	`mypassword`
エンコードされていない認証情報	`admin@internal:mypassword`
Base64 エンコードされた認証情報	`YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==`

Base64 でエンコードされた認証情報を以下のように指定します。

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==

HTTP/1.1 200 OK

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==

HTTP/1.1 200 OK

Copy to Clipboard

Toggle word wrap

重要

Basic 認証では、パスワードなどの機密情報がプレーンテキストで送信される可能性があります。API では、プレーンテキスト要求のトランスポートレベルの暗号化に Hypertext Transfer Protocol Secure (HTTPS) が必要です。

重要

Base64 ライブラリーによっては、結果を複数行に分割して、行末には改行文字をつけます。これによりヘッダーが破損し、要求に問題が発生します。Authorization ヘッダーには、エンコードされた認証情報がヘッダー内に一行で記載されている必要があります。

2.2.3. 認証セッション
リンクのコピー

API は認証セッションサポートを提供します。認証情報で最初の要求を送信し、次にセッションクッキーを使用して後続のすべての要求を送信し、認証を行います。

2.2.3.1. 認証されたセッションの要求
リンクのコピー

Authorization および Prefer: persistent-auth ヘッダーを使用して要求を送信します。

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==
Prefer: persistent-auth

HTTP/1.1 200 OK
...

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==
Prefer: persistent-auth

HTTP/1.1 200 OK
...

Copy to Clipboard

Toggle word wrap

これは、以下のヘッダーで応答を返します。

Set-Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK; Path=/ovirt-engine/api; Secure

Set-Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK; Path=/ovirt-engine/api; Secure

Copy to Clipboard

Toggle word wrap

JSESSIONID= の値を書き留めておきます。この例では、値は 5dQja5ubr4yvI2MM2z+LZxrK です。

JSESSIONID= の値で Prefer: persistent-auth および Cookie ヘッダーで後続のすべての要求を送信します。認証セッションを使用する場合は、Authorization ヘッダーが不要になりました。

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Prefer: persistent-auth
Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK

HTTP/1.1 200 OK
...

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Prefer: persistent-auth
Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK

HTTP/1.1 200 OK
...

Copy to Clipboard

Toggle word wrap

セッションが必要なくなった場合は、Prefer: persistent-auth ヘッダーなしでサーバーへの要求を実行します。

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==

HTTP/1.1 200 OK
...

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==

HTTP/1.1 200 OK
...

Copy to Clipboard

Toggle word wrap

^[1] Basic 認証については、RFC 2617: HTTP Authentication: Basic and Digest Access Authentication で説明されています。

第3章一般的な概念
リンクのコピー

3.1. タイプ
リンクのコピー

API は タイプ の概念を使用して、受け入れおよび返されたさまざまな種類のオブジェクトを記述します。

関連するタイプには次の 3 種類があります。

プリミティブ型: 文字列や整数などの単純な種類のオブジェクトを記述します。
列挙型: VmStatus または DiskFormat などの有効な値のリストを記述します。
構造化型: Vm や Disk などの複数の属性とリンクを使用して、構造化されたオブジェクトを記述します。

3.2. 特定タイプ
リンクのコピー

API によって使用されるタイプの多くは、identified オブジェクトを表します。このオブジェクトは、一意の識別子が割り当てられており、他のオブジェクトとは独立して存在します。これらのオブジェクトの記述に使用されるタイプは、以下の共通属性のセットが含まれる Identified タイプを拡張します。

Expand

属性	タイプ	Description
`id`	String	仮想化インフラストラクチャーの各オブジェクトには、一意の ID として機能する `id` が含まれます。
`href`	String	絶対パスとしてのオブジェクトの正規の場所。
`name`	String	ユーザーが指定する、人間が判読可能なオブジェクト名。`name` 名は、同じタイプのすべてのオブジェクトの中で一意です。
`description`	String	ユーザーが指定する、人間が判読可能なオブジェクトの説明 (フリーフォーム)。

重要

現時点で、ほとんどの種類のオブジェクトでは、id 属性は実際には無作為に生成された UUID ですが、これは実装の情報であり、今後変更される可能性があるため、この情報に依存しないようにしてください。代わりにユーザーは、これらの識別子が文字列であると仮定する必要があります。

3.3. オブジェクト
リンクのコピー

オブジェクトは、API でサポートされるタイプの個別インスタンスです。たとえば、識別子が 123 の仮想マシンは、Vm タイプのオブジェクトです。

3.4. コレクション
リンクのコピー

コレクションは、同じタイプのオブジェクトのセットです。

3.5. 表現
リンクのコピー

オブジェクトの状態は、クライアントとサーバーを転送する時に表現する必要があります。API は、入力と出力の両方で、オブジェクトの状態を表す XML と JSON をサポートします。

3.5.1. XML 表現
リンクのコピー

オブジェクトの XML 表現は、オブジェクトのタイプに対応する XML 要素、id 属性と href 属性に対応する XML 属性、残りの属性に対応する XML 要素のネストで構成されます。たとえば、仮想マシンの XML 表現は以下のようになります。

<vm id="123" href="/ovirt-engine/api/vms/123">
  <name>myvm</name>
  <description>My VM</description>
  <memory>1073741824</memory>
  ...
</vm>

<vm id="123" href="/ovirt-engine/api/vms/123">
  <name>myvm</name>
  <description>My VM</description>
  <memory>1073741824</memory>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

オブジェクトのコレクションの XML 表現は、オブジェクトのタイプの名前が複数ある XML 要素で構成されます。これには、コレクションのオブジェクトの表現が含まれます。たとえば、仮想マシンのコレクションに対する XML 表現は以下のようになります。

<vms>
  <vm id="123" href="/ovirt-engine/api/vms/123">
    <name>yourvm</name>
    <description>Your VM</description>
    <memory>1073741824</memory>
    ...
  </vm>
  <vm id="456" href="/ovirt-engine/api/vms/456">
    <name>myname</name>
    <description>My description</description>
    <memory>2147483648</memory>
    ...
  </vm>
  ...
</vms>

<vms>
  <vm id="123" href="/ovirt-engine/api/vms/123">
    <name>yourvm</name>
    <description>Your VM</description>
    <memory>1073741824</memory>
    ...
  </vm>
  <vm id="456" href="/ovirt-engine/api/vms/456">
    <name>myname</name>
    <description>My description</description>
    <memory>2147483648</memory>
    ...
  </vm>
  ...
</vms>

Copy to Clipboard

Toggle word wrap

重要

オブジェクトの XML 表現では、id および href 属性は XML 属性として表現される唯一の属性で、残りはネストされた XML 要素として表されます。

3.5.2. JSON 表現
リンクのコピー

オブジェクトの JSON 表現は、各属性の名前/値のペア (id および href など) を含む JSON ドキュメントで構成されます。たとえば、仮想マシンの JSON 表現は以下のようになります。

{
  "id": "123",
  "href": "/ovirt-engine/api/vms/123",
  "name": "myvm",
  "description": "My VM",
  "memory": 1073741824,
  ...
}

{
  "id": "123",
  "href": "/ovirt-engine/api/vms/123",
  "name": "myvm",
  "description": "My VM",
  "memory": 1073741824,
  ...
}

Copy to Clipboard

Toggle word wrap

オブジェクトコレクションの JSON 表現には、名前/値のペア (単数でオブジェクトのタイプの名前) などの JSON ドキュメントで構成され、その中にコレクションのオブジェクトの表現が指定されたアレイが含まれます。たとえば、仮想マシンのコレクションの JSON 表現は以下のようになります。

{
  "vm": [
    {
      "id": "123",
      "href": "/ovirt-engine/api/vms/123",
      "name": "myvm",
      "description": "My VM",
      "memory": 1073741824,
      ...
    },
    {
      "id": "456",
      "href": "/ovirt-engine/api/vms/456",
      "name": "yourvm",
      "description": "Your VM",
      "memory": 2147483648,
      ...
    },
  ]
}

{
  "vm": [
    {
      "id": "123",
      "href": "/ovirt-engine/api/vms/123",
      "name": "myvm",
      "description": "My VM",
      "memory": 1073741824,
      ...
    },
    {
      "id": "456",
      "href": "/ovirt-engine/api/vms/456",
      "name": "yourvm",
      "description": "Your VM",
      "memory": 2147483648,
      ...
    },
  ]
}

Copy to Clipboard

Toggle word wrap

3.6. サービス
リンクのコピー

サービスは、API がサポートするオブジェクトで取得、更新、削除、および実行を行うサーバーの一部です。

関連するサービスには、以下の 2 つのタイプがあります。

オブジェクトのコレクションを管理するサービス: これらのサービスは、既存のオブジェクトのリストを表示し、新規オブジェクトを追加できます。たとえば、Vms サービスは、システムで利用可能な仮想マシンのコレクションを管理します。
特定のオブジェクトを管理するサービス: これらのサービスは、特定のオブジェクトでアクションの取得、更新、および削除、および実行を行います。たとえば、Vm サービスは特定の仮想マシンを管理します。

各サービスは、サーバー内の特定のパスからアクセスできます。たとえば、システムで利用可能な仮想マシンのコレクションを管理するサービスは、パス /vms に、仮想マシン 123 を管理するサービスは、パス /vms/123 にあります。

種類が何であってもサービスには、実行できる操作を表す メソッド のセットがあります。オブジェクトのコレクションを管理するサービスは通常、list と add メソッドをサポートします。特定のオブジェクトを管理するサービスには、通常、get、update メソッド、および remove メソッドがあります。さらに、サービスには、あまり一般的ではない操作を表す action メソッドも含まれることがあります。たとえば、Vm サービスには、仮想マシンの起動に使用される start メソッドがあります。

通常のメソッドでは、メソッドの名前と HTTP メソッドの名前の間で直接マッピングされます。

Expand

メソッド名	HTTP メソッド
`add`	POST
`get`	GET
`list`	GET
`更新`	PUT
`remove`	DELETE

HTTP 要求で使用されるパスは、接頭辞が /ovirt-engine/api のサービスのパスです。

たとえば、仮想マシンを リスト表示 するリクエストは、HTTP GET メソッドとパス /vms を使用して、以下のように指定します。

GET /ovirt-engine/api/vms

GET /ovirt-engine/api/vms

Copy to Clipboard

Toggle word wrap

アクションメソッドの場合には、HTTP メソッドは常に POST になり、メソッドの名前が接尾辞としてパスに追加されます。たとえば、仮想マシン 123 を起動する要求は、HTTP POST メソッドとパス /vms/123/start を使用して以下のように指定します。

POST /ovirt-engine/api/vms/123/start

POST /ovirt-engine/api/vms/123/start

Copy to Clipboard

Toggle word wrap

メソッドごとにパラメーターセットがあります。

パラメーターは 2 つのカテゴリーに分類されます。

主なパラメーター: 主要なパラメーターは、取得、追加、または更新するオブジェクトまたはコレクションに対応します。これは add、get、list、update メソッドにのみ適用され、1 メソッドごとにこのような主要パラメーターは 1 つだけ存在します。
セカンダリーパラメーター: 残りのパラメーター。

たとえば、仮想マシンを追加する操作 (こちらを参照) には、vm、clone、および clone_permissions の 3 つのパラメーターがあります。追加するオブジェクトを記述するため、主要パラメーターは vm です。clone および clone_permissions パラメーターはセカンダリーパラメーターです。

入力に使用する主要パラメーターは、HTTP 要求の本文に含める必要があります。たとえば、仮想マシンを追加する場合は、Vm タイプの vm パラメーターをリクエスト本文に含める必要があります。つまり、すべての HTTP の情報が含まれる、仮想マシン追加の完全な要求は、以下のようになります。

POST /ovirt-engine/api/vms HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
</vm>

POST /ovirt-engine/api/vms HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
</vm>

Copy to Clipboard

Toggle word wrap

出力に使用すると、主要なパラメーターは応答ボディーに含まれます。たとえば、仮想マシンを追加する場合、vm パラメーターは応答ボディーに含まれます。そのため、完全な応答ボディーは以下のようになります。

HTTP/1.1 201 Created
Content-Type: application/xml

<vm href="/ovirt-engine/api/vms/123" id="123">
  <name>myvm</name>
  <description>My VM</description>
  ...
</vm>

HTTP/1.1 201 Created
Content-Type: application/xml

<vm href="/ovirt-engine/api/vms/123" id="123">
  <name>myvm</name>
  <description>My VM</description>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

セカンダリーパラメーターは (後に説明している action メソッドを除く) 入力のみが可能で、クエリーパラメーターとして組み込む必要があります。たとえば、clone パラメーターが true に設定された仮想マシンを追加する場合に、完全な要求は以下のようになります。

POST /ovirt-engine/api/vms?clone=true HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
</vm>

POST /ovirt-engine/api/vms?clone=true HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
</vm>

Copy to Clipboard

Toggle word wrap

action メソッドにはセカンダリーパラメーターだけが含まれます。これらは入出力に使用でき、action 要素でラップされたリクエスト本文に含める必要があります。たとえば、仮想マシンを起動する action メソッド (こちらを参照) には、仮想マシンの起動方法を記述する vm パラメーターと、ゲスト OS を設定するために cloud-init を使用するかどうかを指定する use_cloud_init パラメーターがあります。そのため、XML を使用する場合には、cloud-init を使用して仮想マシン 123 を起動する完全な要求は以下のようになります。

POST /ovirt-engine/api/vms/123/start HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<action>
  <use_cloud_init>true</use_cloud_init>
  <vm>
    <initialization>
      <nic_configurations>
        <nic_configuration>
          <name>eth0</name>
          <on_boot>true</on_boot>
          <boot_protocol>static</boot_protocol>
          <ip>
            <address>192.168.0.100</address>
            <netmask>255.255.255.0</netmask>
            <gateway>192.168.0.1</netmask>
          </ip>
        </nic_configuration>
      </nic_configurations>
      <dns_servers>192.168.0.1</dns_servers>
    </initialization>
  </vm>
</action>

POST /ovirt-engine/api/vms/123/start HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<action>
  <use_cloud_init>true</use_cloud_init>
  <vm>
    <initialization>
      <nic_configurations>
        <nic_configuration>
          <name>eth0</name>
          <on_boot>true</on_boot>
          <boot_protocol>static</boot_protocol>
          <ip>
            <address>192.168.0.100</address>
            <netmask>255.255.255.0</netmask>
            <gateway>192.168.0.1</netmask>
          </ip>
        </nic_configuration>
      </nic_configurations>
      <dns_servers>192.168.0.1</dns_servers>
    </initialization>
  </vm>
</action>

Copy to Clipboard

Toggle word wrap

3.7. 検索
リンクのコピー

一部のサービスの list メソッドには、検索 条件の指定に使用できる search パラメーターがあります。これを使用すると、サーバーは上記の基準を満たすコレクション内のオブジェクトのみを返します。たとえば、以下の要求では myvm という名前の仮想マシンのみを返します。

GET /ovirt-engine/api/vms?search=name%3Dmyvm

GET /ovirt-engine/api/vms?search=name%3Dmyvm

Copy to Clipboard

Toggle word wrap

3.7.1. 最大結果パラメーター
リンクのコピー

max パラメーターを使用して、返されるオブジェクトの数を制限します。たとえば、以下の要求は、システムで利用可能なものに関係なく、仮想マシンが 1 つだけ返されます。

GET /ovirt-engine/api/vms?max=1

GET /ovirt-engine/api/vms?max=1

Copy to Clipboard

Toggle word wrap

max パラメーターのない検索要求は、すべてのオブジェクトを返します。システムの全体的なパフォーマンスにおける要求の影響を減らすために、max パラメーターを指定することが推奨されます。

3.7.2. ケースの機密性
リンクのコピー

デフォルトでは、クエリーは大文字と小文字を区別しません。たとえば、以下の要求は、myvm、MyVM、および MYVM という名前の仮想マシンを返します。

GET /ovirt-engine/api/vms?search=name%3Dmyvm

GET /ovirt-engine/api/vms?search=name%3Dmyvm

Copy to Clipboard

Toggle word wrap

この動作を変更するには、任意の case_sensitive boolean パラメーターを使用できます。たとえば、MyHost または MYHOST ではなく myhost という名前の仮想マシンを取得するには、以下のように要求を送信します。

GET /ovirt-engine/api/vms?search=name%3D=myvm&case_sensitive=true

GET /ovirt-engine/api/vms?search=name%3D=myvm&case_sensitive=true

Copy to Clipboard

Toggle word wrap

3.7.3. 検索構文
リンクのコピー

search パラメーターは、Red Hat Virtualization クエリー言語と同じ構文を使用します。

(criteria) [sortby (element) asc|desc]

(criteria) [sortby (element) asc|desc]

Copy to Clipboard

Toggle word wrap

sortby 句はオプションで、結果を順序付ける場合にのみ必要です。

検索クエリーの例

Expand

コレクション	基準	結果
`hosts`	`vms.status=up`	`稼働` 中の仮想マシンを実行しているすべてのホストリストを返します。
`vms`	`domain=example.com`	指定されたドメインで稼働しているすべての仮想マシンのリストを返します。
`vms`	`users.name=mary`	ユーザー名が `Mary` のユーザーに属する全仮想マシンのリストを返します。
`events`	`severity > normal sortby time`	重大度が `通常` よりも高いすべてのイベントのリストを返します。`time` 属性の値でソートされます。
`events`	`severity > normal sortby time desc`	重大度が `通常` よりも高いすべてのイベントのリストを返します。`time` 属性の値を降順で並び替えます。

search パラメーターの値は、演算子やスペースなどの予約済み文字を変換するために URL エンコードされている必要があります。たとえば、等号は %3D としてエンコードする必要があります。

GET /ovirt-engine/api/vms?search=name%3Dmyvm

GET /ovirt-engine/api/vms?search=name%3Dmyvm

Copy to Clipboard

Toggle word wrap

3.7.4. ワイルドカード
リンクのコピー

アスタリスクは値の一部として使用して、empty の文字列が含まれる文字列を検索できます。たとえば、以下のリクエストでは、myvm、myvm2、myvma、myvm-webserver など、myvm で始まる名前の仮想マシンをすべて返します。

GET /ovirt-engine/api/vms?search=name%3Dmyvm*

GET /ovirt-engine/api/vms?search=name%3Dmyvm*

Copy to Clipboard

Toggle word wrap

3.7.5. ページネーション
リンクのコピー

一部の Red Hat Virtualization 環境には、大規模なオブジェクトが含まれます。一度のリクエストですべてを取得するのは現実的ではなく、パフォーマンスも悪くなります。ページ単位での検索を可能にするため、search パラメーターはオプションで page 句をサポートしています。これは、max パラメーターと組み合わせてページングの基礎となります。たとえば、ページサイズが 10 の仮想マシンの最初のページを取得するには、以下のように要求を送信します。

GET /ovirt-engine/api/vms?search=page%201&max=10

GET /ovirt-engine/api/vms?search=page%201&max=10

Copy to Clipboard

Toggle word wrap

注記

search パラメーターは URL エンコードされており、エンコード前の実際の search パラメーターの値は page 1 なので、実際には 1 ページ目を要求していることになります。

page 値を増やして、次のページを取得します。

GET /ovirt-engine/api/vms?search=page%202&max=10

GET /ovirt-engine/api/vms?search=page%202&max=10

Copy to Clipboard

Toggle word wrap

page 句は、search パラメーター内の他の句と組み合わせて使用できます。たとえば、以下の要求は仮想マシンの 2 ページ目を返しますが、名前で並べ替えます。

GET /ovirt-engine/api/vms?search=sortby%20name%20page%202&max=10

GET /ovirt-engine/api/vms?search=sortby%20name%20page%202&max=10

Copy to Clipboard

Toggle word wrap

重要

API はステートレスで、すべての要求が互いに独立しているため、異なる要求間で状態を維持することはできません。その結果、要求間でステータスが変更されると、ページの結果に一貫性がなくなることがあります。

たとえば、仮想マシンのリストから特定のページを要求し、次のページを要求する前に仮想マシンが作成または削除された場合には、結果の一部が欠落しているか、または重複が含まれる可能性があります。

3.8. リンクの移動
リンクのコピー

API は リンク として関連するオブジェクトへの参照を返します。たとえば、仮想マシンを取得すると、ディスクアタッチメントとネットワークインターフェイスカードへのリンクが含まれます。

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <link rel="diskattachments" href="/ovirt-engine/api/vms/123/diskattachments"/>
  <link rel="nics" href="/ovirt-engine/api/vms/123/nics"/>
  ...
</vm>

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <link rel="diskattachments" href="/ovirt-engine/api/vms/123/diskattachments"/>
  <link rel="nics" href="/ovirt-engine/api/vms/123/nics"/>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

リンク したオブジェクトの完全な説明は、別の要求を送信することで取得できます。

GET /ovirt-engine/api/vms/123/diskattachments
GET /ovirt-engine/api/vms/123/nics

GET /ovirt-engine/api/vms/123/diskattachments
GET /ovirt-engine/api/vms/123/nics

Copy to Clipboard

Toggle word wrap

ただし、状況によっては、API を使用するアプリケーションが同じ要求でリンクされた情報を取得する方が便利な場合があります。追加のネットワークのラウンドトリップが原因でオーバーヘッドが許容できない範囲になったり、複数の要求が原因でアプリケーションのコードが許容できない範囲で複雑化する場合に便利です。これらのユースケースでは、API は、アプリケーションが要求を 1 つだけ使用してリンクされた情報を取得できるようにする follow パラメーターを提供します。

follow パラメーターの値は、コンマで区切られた文字列のリストです。これらの各文字列は、リンクされたオブジェクトのパスです。たとえば、上記の例でディスクの割り当てと NIC を取得するには、要求は以下のようになります。

GET /ovirt-engine/api/vms/123?follow=disk_attachments,nics

GET /ovirt-engine/api/vms/123?follow=disk_attachments,nics

Copy to Clipboard

Toggle word wrap

これにより、以下のような応答が返されます。

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <disk_attachments>
    <disk_attachment id="456" href="/ovirt-engine/api/vms/123/diskattachments/456">
      <active>true</active>
      <bootable>true</bootable>
      <interface>virtio_scsi</interface>
      <pass_discard>false</pass_discard>
      <read_only>false</read_only>
      <uses_scsi_reservation>false</uses_scsi_reservation>
      <disk id="789" href="/ovirt-engine/api/disks/789"/>
    </disk_attachment>
    ...
  </disk_attacments>
  <nics>
    <nic id="234" href="/ovirt-engine/api/vms/123/nics/234">
      <name>eth0</name>
      <interface>virtio</interface>
      <linked>true</linked>
      <mac>
        <address>00:1a:4a:16:01:00</address>
      </mac>
      <plugged>true</plugged>
    </nic>
    ...
  </nics>
  ...
</vm>

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <disk_attachments>
    <disk_attachment id="456" href="/ovirt-engine/api/vms/123/diskattachments/456">
      <active>true</active>
      <bootable>true</bootable>
      <interface>virtio_scsi</interface>
      <pass_discard>false</pass_discard>
      <read_only>false</read_only>
      <uses_scsi_reservation>false</uses_scsi_reservation>
      <disk id="789" href="/ovirt-engine/api/disks/789"/>
    </disk_attachment>
    ...
  </disk_attacments>
  <nics>
    <nic id="234" href="/ovirt-engine/api/vms/123/nics/234">
      <name>eth0</name>
      <interface>virtio</interface>
      <linked>true</linked>
      <mac>
        <address>00:1a:4a:16:01:00</address>
      </mac>
      <plugged>true</plugged>
    </nic>
    ...
  </nics>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

リンクされたオブジェクトへのパスは、前の例のように 1 つの単語とすることも、ドットで区切った単語シーケンスで、入れ子データを要求することもできます。たとえば、前述の例では、ディスク割り当ての説明すべてを取得するために disk_attachments を使用しましたが、各ディスク割り当てにはディスクへのリンクが含まれていますが、各ディスク割当にはそのディスクへのリンクが含まれており、リンクは フォロー されていませんでした。また、ディスクへのリンクをたどるには、以下の要求を使用できます。

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk

Copy to Clipboard

Toggle word wrap

これにより、以下の応答が生成されます。

<vm id="123" href="/ovirt-engine/api/vms/123">
  <disk_attachments>
    <disk_attachment id="456" href="/ovirt-engine/api/vms/123/diskattachments/456">
      <active>true</active>
      <bootable>true</bootable>
      <interface>virtio_scsi</interface>
      <pass_discard>false</pass_discard>
      <read_only>false</read_only>
      <uses_scsi_reservation>false</uses_scsi_reservation>
      <disk id="789" href="/ovirt-engine/api/disks/789">
        <name>mydisk</name>
        <description>My disk</description>
        <actual_size>0</actual_size>
        <format>raw</format>
        <sparse>true</sparse>
        <status>ok</status>
        <storage_type>image</storage_type>
        <total_size>0</total_size>
        ...
      </disk>
    </disk_attachment>
    ...
  </disk_attachments>
  ...
</vm>

<vm id="123" href="/ovirt-engine/api/vms/123">
  <disk_attachments>
    <disk_attachment id="456" href="/ovirt-engine/api/vms/123/diskattachments/456">
      <active>true</active>
      <bootable>true</bootable>
      <interface>virtio_scsi</interface>
      <pass_discard>false</pass_discard>
      <read_only>false</read_only>
      <uses_scsi_reservation>false</uses_scsi_reservation>
      <disk id="789" href="/ovirt-engine/api/disks/789">
        <name>mydisk</name>
        <description>My disk</description>
        <actual_size>0</actual_size>
        <format>raw</format>
        <sparse>true</sparse>
        <status>ok</status>
        <storage_type>image</storage_type>
        <total_size>0</total_size>
        ...
      </disk>
    </disk_attachment>
    ...
  </disk_attachments>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

パスは、必要に応じて階層を深くすることができます。たとえば、ディスクの統計も取得するには、以下のコマンドを実行します。

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics

Copy to Clipboard

Toggle word wrap

複数のパス要素と複数のパスを組み合わせることができます。たとえば、ディスクの割り当てとネットワークインターフェイスカードを、どちらも統計で取得するには、次のコマンドを実行します。

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics,nics.statistics

GET /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics,nics.statistics

Copy to Clipboard

Toggle word wrap

重要

オブジェクト取得の操作の大半は、follow のパラメーターをサポートしますが、一部の操作ではサポートされていない場合や、ドキュメントに、最適なパフォーマンスを得るためのアドバイスが含まれる場合があるので、参照ドキュメントを詳細に確認してください。

重要

follow パラメーターを使用すると、オーバーヘッドがクライアント側からサーバー側に移動します。追加のデータを要求する場合には、サーバーはその要求取得して基本データとマージする必要があります。これはサーバー側で CPU およびメモリーを消費し、ほとんどの場合に追加のデータベースクエリーが必要になります。これは、特に大規模な環境では、サーバーのパフォーマンスに悪影響を与える可能性があります。必ず実際の環境でアプリケーションをテストし、正当な理由がある場合にのみ follow パラメーターを使用してください。

3.9. パーミッション
リンクのコピー

単一オブジェクトを管理するサービスの多くは、そのオブジェクトに割り当てられたパーミッションを管理する permissions サービスへの参照を提供します。各パーミッションには、ユーザーまたはグループ、ロール、およびオブジェクトへのリンクが含まれます。たとえば、特定の仮想マシンに割り当てられているパーミッションは、以下のような要求を送信して取得できます。

GET /ovirt-engine/api/vms/123/permissions

GET /ovirt-engine/api/vms/123/permissions

Copy to Clipboard

Toggle word wrap

応答ボディーは以下のようになります。

<permissions>
  <permission id="456" href="/ovirt-engien/api/vms/123/permissions/456">
    <user id="789" href="/ovirt-engine/api/users/789"/>
    <role id="abc" href="/ovirt-engine/api/roles/abc"/>
    <vm id="123" href="/ovirt-engine/api/vms/123"/>
  </permission>
  ...
</permissions>

<permissions>
  <permission id="456" href="/ovirt-engien/api/vms/123/permissions/456">
    <user id="789" href="/ovirt-engine/api/users/789"/>
    <role id="abc" href="/ovirt-engine/api/roles/abc"/>
    <vm id="123" href="/ovirt-engine/api/vms/123"/>
  </permission>
  ...
</permissions>

Copy to Clipboard

Toggle word wrap

パーミッションは、このサービスへのパーミッション表現を含む POST 要求を送信するオブジェクトに追加されます。それぞれの新規パーミッションには、ロールとユーザーが必要です。

3.10. エラーの処理
リンクのコピー

エラーによっては、標準的な HTTP ステータスコード以外の詳しい説明が必要です。たとえば、API は応答ボディーに 問題 があるオブジェクトの状態の更新またはアクションを報告します。障害には reason および detail 属性が含まれます。たとえば、サーバーが必須 name 属性なしで仮想マシンを作成する要求を受信すると、以下の HTTP 応答行が返されます。

HTTP/1.1 400 Bad Request

HTTP/1.1 400 Bad Request

Copy to Clipboard

Toggle word wrap

そして、応答のボディーは以下のとおりです。

<fault>
  <reason>Incomplete parameters</reason>
  <detail>Vm [name] required for add</detail>
</fault>

<fault>
  <reason>Incomplete parameters</reason>
  <detail>Vm [name] required for add</detail>
</fault>

Copy to Clipboard

Toggle word wrap

第4章クイックスタートの例
リンクのコピー

このセクションの例では、REST API を使用して基本的な Red Hat Virtualization 環境を設定し、仮想マシンを作成する方法を説明します。これらの例では、標準の前提条件に加えて、以下が必要です。

ネットワーク接続され、設定済みの Red Hat Virtualization ホスト。
インストールする仮想マシンのオペレーティングシステムを含む ISO ファイル。この章では、インストール ISO のサンプルとして CentOS 7 を使用します。

API の例では、curl を使用してクライアントアプリケーションでの API 要求を紹介します。HTTP 要求を送信するアプリケーションを使用できます。

重要

この例の HTTP 要求ヘッダーでは、Host と Authorization ヘッダーが省略されています。ただし、これらのフィールドは必須であり、Red Hat Virtualization のインストールに固有のデータを必要とします。

curl の例では、ユーザー名に admin@internal、パスワードに mypassword、証明書の場所には /etc/pki/ovirt-engine/ca.pem、ホスト名に myengine.example.com を使用します。ご使用の環境の正しい値に置き換える必要があります。

Red Hat Virtualization は、リソースごとに id 属性の一意の ID を生成します。これらの例の識別子コードは、お使いの Red Hat Virtualization 環境の識別子コードとは異なります。

多くの例では、API によって返される結果の属性の一部が省略され、簡潔さが保たれます。属性の完全なリストは、クラスター reference を参照してください。

4.1. API エントリーポイントへのアクセス
リンクのコピー

以下の要求は、API のバージョン 4 のメインエントリーポイントの表現を取得します。

GET /ovirt-engine/api HTTP/1.1
Version: 4
Accept: application/xml

GET /ovirt-engine/api HTTP/1.1
Version: 4
Accept: application/xml

Copy to Clipboard

Toggle word wrap

同じリクエストですが、Version ヘッダーの代わりに /v4 URL 接頭辞を使用します。

GET /ovirt-engine/api/v4 HTTP/1.1
Accept: application/xml

GET /ovirt-engine/api/v4 HTTP/1.1
Accept: application/xml

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api

Copy to Clipboard

Toggle word wrap

結果は、Api タイプのオブジェクトです。

<api>
  <link href="/ovirt-engine/api/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters" rel="datacenters"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.0.0-0.0.el7</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="..." id="..."/>
    <root_tag href="..." id="..."/>
  </special_objects>
  <summary>
    <hosts>
      <active>23</active>
      <total>30</total>
    </hosts>
    <storage_domains>
      <active>5</active>
      <total>6</total>
    </storage_domains>
    <users>
      <active>12</active>
      <total>102</total>
    </users>
    <vms>
      <active>253</active>
      <total>545</total>
    </vms>
  </summary>
  <time>2016-10-06T15:38:18.548+02:00</time>
</api>

<api>
  <link href="/ovirt-engine/api/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters" rel="datacenters"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.0.0-0.0.el7</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="..." id="..."/>
    <root_tag href="..." id="..."/>
  </special_objects>
  <summary>
    <hosts>
      <active>23</active>
      <total>30</total>
    </hosts>
    <storage_domains>
      <active>5</active>
      <total>6</total>
    </storage_domains>
    <users>
      <active>12</active>
      <total>102</total>
    </users>
    <vms>
      <active>253</active>
      <total>545</total>
    </vms>
  </summary>
  <time>2016-10-06T15:38:18.548+02:00</time>
</api>

Copy to Clipboard

Toggle word wrap

重要

ヘッダーと URL 接頭辞が使用されていない場合には、サーバーは自動的にバージョンを選択します。デフォルトはバージョン 4 です。ENGINE_API_DEFAULT_VERSION 設定パラメーターを使用してデフォルトのバージョンを変更できます。

echo "ENGINE_API_DEFAULT_VERSION=3" > \
/etc/ovirt-engine/engine.conf.d/99-set-default-version.conf
systemctl restart ovirt-engine

# echo "ENGINE_API_DEFAULT_VERSION=3" > \
/etc/ovirt-engine/engine.conf.d/99-set-default-version.conf
# systemctl restart ovirt-engine

Copy to Clipboard

Toggle word wrap

このパラメーターを変更すると、バージョンを明示的に指定しない API のすべてのユーザーに影響があります。

エントリーポイントは、仮想化環境のコレクションへのリンクをユーザーに提供します。各コレクションリンクの rel 属性は、各リンクの参照ポイントを提供します。この例の次のステップは、データセンターコレクションを検証し、これは datacenters リンクから入手できます。

エントリーポイントには、product_info、special_objects、summary などの他のデータも含まれます。このデータは、この例以外の章で説明しています。

4.2. データセンターのリスト表示
リンクのコピー

Red Hat Virtualization は、インストール時に Default のデータセンターを作成します。以下の例では、仮想環境のベースとして Default データセンターを使用します。

以下の要求は、データセンターの表現を取得します。

GET /ovirt-engine/api/datacenters HTTP/1.1
Accept: application/xml

GET /ovirt-engine/api/datacenters HTTP/1.1
Accept: application/xml

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/datacenters

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/datacenters

Copy to Clipboard

Toggle word wrap

結果として、DataCenter タイプのオブジェクトリストが作成されます。

<data_centers>
  <data_center href="/ovirt-engine/api/datacenters/001" id="001">
    <name>Default</name>
    <description>The default Data Center</description>
    <link href="/ovirt-engine/api/datacenters/001/clusters" rel="clusters"/>
    <link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>
    ...
    <local>false</local>
    <quota_mode>disabled</quota_mode>
    <status>up</status>
    <supported_versions>
      <version>
        <major>4</major>
        <minor>0</minor>
      </version>
    </supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
  </data_center>
  ...
</data_centers>

<data_centers>
  <data_center href="/ovirt-engine/api/datacenters/001" id="001">
    <name>Default</name>
    <description>The default Data Center</description>
    <link href="/ovirt-engine/api/datacenters/001/clusters" rel="clusters"/>
    <link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>
    ...
    <local>false</local>
    <quota_mode>disabled</quota_mode>
    <status>up</status>
    <supported_versions>
      <version>
        <major>4</major>
        <minor>0</minor>
      </version>
    </supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
  </data_center>
  ...
</data_centers>

Copy to Clipboard

Toggle word wrap

Default データ センター の ID をメモします。仮想環境の他のリソースに関連して、このデータセンターを特定します。

データセンターには、データセンターにアタッチされたストレージドメインを管理するサービスへのリンクも含まれています。

<link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>

<link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>

Copy to Clipboard

Toggle word wrap

このサービスは、メインの storagedomains コレクションからストレージドメインを割り当てるために使用されます。この例では、この点について後ほど説明します。

4.3. ホストクラスターのリスト表示
リンクのコピー

Red Hat Virtualization は、インストール時に Default ホストクラスターを作成します。この例では、Default クラスターを使用して Red Hat Virtualization 環境のリソースをグループ化します。

以下の要求は、クラスターコレクションの表現を取得します。

GET /ovirt-engine/api/clusters HTTP/1.1
Accept: application/xml

GET /ovirt-engine/api/clusters HTTP/1.1
Accept: application/xml

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/clusters

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/clusters

Copy to Clipboard

Toggle word wrap

結果として、Cluster タイプのオブジェクトのリストが表示されます。

<clusters>
  <cluster href="/ovirt-engine/api/clusters/002" id="002">
    <name>Default</name>
    <description>The default server cluster</description>
    <link href="/ovirt-engine/api/clusters/002/networks" rel="networks"/>
    <link href="/ovirt-engine/api/clusters/002" rel="permissions"/>
    ...
    <cpu>
      <architecture>x86_64</architecture>
      <type>Intel Nehalem Family</type>
    </cpu>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
    <data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
  </cluster>
  ...
</clusters>

<clusters>
  <cluster href="/ovirt-engine/api/clusters/002" id="002">
    <name>Default</name>
    <description>The default server cluster</description>
    <link href="/ovirt-engine/api/clusters/002/networks" rel="networks"/>
    <link href="/ovirt-engine/api/clusters/002" rel="permissions"/>
    ...
    <cpu>
      <architecture>x86_64</architecture>
      <type>Intel Nehalem Family</type>
    </cpu>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
    <data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
  </cluster>
  ...
</clusters>

Copy to Clipboard

Toggle word wrap

Default ホストのクラスターの ID をメモします。仮想環境の他のリソースと照合して、このホストクラスターを特定します。

Default クラスターは、data_center リンクの id および href 属性を使用する関係により Default データセンターに関連付けられます。

<data_center href="/ovirt-engine/api/datacenters/001" id="001"/>

<data_center href="/ovirt-engine/api/datacenters/001" id="001"/>

Copy to Clipboard

Toggle word wrap

networks リンクは、このクラスターに関連付けられたネットワークを管理するサービスへの参照です。次のセクションでは、ネットワークコレクションの詳細を説明します。

4.4. 論理ネットワークのリスト表示
リンクのコピー

Red Hat Virtualization は、インストール時にデフォルトの ovirtmgmt ネットワークを作成します。このネットワークは、Red Hat Virtualization Manager がホストにアクセスするための管理ネットワークとして機能します。

このネットワークは Default クラスターに関連付けられており、Default データセンターのメンバーです。この例では、ovirtmgmt ネットワークを使用して仮想マシンに接続します。

以下の要求は、論理ネットワークのリストを取得します。

GET /ovirt-engine/api/networks HTTP/1.1
Accept: application/xml

GET /ovirt-engine/api/networks HTTP/1.1
Accept: application/xml

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/networks

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/networks

Copy to Clipboard

Toggle word wrap

結果として、Network タイプのオブジェクトのリストが表示されます。

<networks>
  <network href="/ovirt-engine/api/networks/003" id="003">
    <name>ovirtmgmt</name>
    <description>Management Network</description>
    <link href="/ovirt-engine/api/networks/003/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/networks/003/vnicprofiles" rel="vnicprofiles"/>
    <link href="/ovirt-engine/api/networks/003/networklabels" rel="networklabels"/>
    <mtu>0</mtu>
    <stp>false</stp>
    <usages>
      <usage>vm</usage>
    </usages>
    <data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
  </network>
  ...
</networks>

<networks>
  <network href="/ovirt-engine/api/networks/003" id="003">
    <name>ovirtmgmt</name>
    <description>Management Network</description>
    <link href="/ovirt-engine/api/networks/003/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/networks/003/vnicprofiles" rel="vnicprofiles"/>
    <link href="/ovirt-engine/api/networks/003/networklabels" rel="networklabels"/>
    <mtu>0</mtu>
    <stp>false</stp>
    <usages>
      <usage>vm</usage>
    </usages>
    <data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
  </network>
  ...
</networks>

Copy to Clipboard

Toggle word wrap

ovirtmgmt ネットワークは、データセンターの ID を使用した関係により Default データセンターに割り当てられます。

ovirtmgmt ネットワークは、クラスターのネットワークサブコレクションの関係を介して Default クラスターにも割り当てられます。

4.5. ホストをリスト表示します。
リンクのコピー

以下の例では、ホストのリストを取得し、仮想化環境に登録されている myhost という名前のホストを表示します。

GET /ovirt-engine/api/hosts HTTP/1.1
Accept: application/xml

GET /ovirt-engine/api/hosts HTTP/1.1
Accept: application/xml

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/hosts

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/hosts

Copy to Clipboard

Toggle word wrap

結果として、Host タイプのオブジェクトのリストが表示されます。

<hosts>
  <host href="/ovirt-engine/api/hosts/004" id="004">
    <name>myhost</name>
    <link href="/ovirt-engine/api/hosts/004/nics" rel="nics"/>
    ...
    <address>node40.example.com</address>
    <cpu>
      <name>Intel Core Processor (Haswell, no TSX)</name>
      <speed>3600</speed>
      <topology>
        <cores>1</cores>
        <sockets>2</sockets>
        <threads>1</threads>
      </topology>
    </cpu>
    <memory>8371830784</memory>
    <os>
      <type>RHEL</type>
      <version>
        <full_version>7 - 2.1511.el7.centos.2.10</full_version>
        <major>7</major>
      </version>
    </os>
    <port>54321</port>
    <status>up</status>
    <cluster href="/ovirt-engine/api/clusters/002" id="002"/>
  </host>
  ...
</hosts>

<hosts>
  <host href="/ovirt-engine/api/hosts/004" id="004">
    <name>myhost</name>
    <link href="/ovirt-engine/api/hosts/004/nics" rel="nics"/>
    ...
    <address>node40.example.com</address>
    <cpu>
      <name>Intel Core Processor (Haswell, no TSX)</name>
      <speed>3600</speed>
      <topology>
        <cores>1</cores>
        <sockets>2</sockets>
        <threads>1</threads>
      </topology>
    </cpu>
    <memory>8371830784</memory>
    <os>
      <type>RHEL</type>
      <version>
        <full_version>7 - 2.1511.el7.centos.2.10</full_version>
        <major>7</major>
      </version>
    </os>
    <port>54321</port>
    <status>up</status>
    <cluster href="/ovirt-engine/api/clusters/002" id="002"/>
  </host>
  ...
</hosts>

Copy to Clipboard

Toggle word wrap

ホストの ID をメモします。仮想環境の他のリソースに関連して、このホストを特定します。

このホストは Default クラスターのメンバーで、nics サブコレクションにアクセスすると、このホストが ovirtmgmt ネットワークに接続されていることが分かります。

4.6. NFS データストレージの作成
リンクのコピー

NFS データストレージドメインは、データセンターに接続されたエクスポートされた NFS 共有であり、仮想化ゲストイメージのストレージを提供します。新規ストレージドメインを作成するには、ストレージドメイン表現が含まれる POST 要求をストレージドメインコレクションの URL に送信する必要があります。

ストレージドメインでは、デフォルトで削除後にワイプオプションを有効にできます。これを設定するには、POST 要求で wipe_after_delete を指定します。このオプションは、ドメインの作成後に編集できますが、その場合はすでに存在している wipe after delete プロパティーは変更されません。

要求は以下のようになります。

POST /ovirt-engine/api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

POST /ovirt-engine/api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

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

<storage_domain>
  <name>mydata</name>
  <type>data</type>
  <description>My data</description>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

<storage_domain>
  <name>mydata</name>
  <type>data</type>
  <description>My data</description>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>mydata</name>
  <description>My data</description>
  <type>data</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/storagedomains

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>mydata</name>
  <description>My data</description>
  <type>data</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/storagedomains

Copy to Clipboard

Toggle word wrap

サーバーはホスト myhost を使用して、mynfs.example.com:/exports/mydata のエクスポートパスで mydata という名前の NFS データストレージドメインを作成します。API は (StorageDomain タイプの) 新規作成されたストレージドメインリソースについて以下の表現も返します。

<storage_domain href="/ovirt-engine/api/storagedomains/005" id="005">
  <name>mydata</name>
  <description>My data</description>
  <available>42949672960</available>
  <committed>0</committed>
  <master>false</master>
  <status>unattached</status>
  <storage>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
    <type>nfs</type>
  </storage>
  <storage_format>v3</storage_format>
  <type>data</type>
  <used>9663676416</used>
</storage_domain>

<storage_domain href="/ovirt-engine/api/storagedomains/005" id="005">
  <name>mydata</name>
  <description>My data</description>
  <available>42949672960</available>
  <committed>0</committed>
  <master>false</master>
  <status>unattached</status>
  <storage>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
    <type>nfs</type>
  </storage>
  <storage_format>v3</storage_format>
  <type>data</type>
  <used>9663676416</used>
</storage_domain>

Copy to Clipboard

Toggle word wrap

4.7. NFS ISO ストレージの作成
リンクのコピー

NFS ISO ストレージドメインは、データセンターにアタッチされ、マウントされた NFS 共有で、DVD/CD-ROM ISO および仮想フロッピーディスク (VFD) イメージファイルのストレージを提供します。新規ストレージドメインを作成するには、ストレージドメイン表現が含まれる POST 要求をストレージドメインコレクションの URL に送信する必要があります。

要求は以下のようになります。

POST /ovirt-engine/api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

POST /ovirt-engine/api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

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

<storage_domain>
  <name>myisos</name>
  <description>My ISOs</description>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

<storage_domain>
  <name>myisos</name>
  <description>My ISOs</description>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>myisos</name>
  <description>My ISOs</description>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/storagedomains

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>myisos</name>
  <description>My ISOs</description>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/storagedomains

Copy to Clipboard

Toggle word wrap

サーバーは、ホスト myhost を使用して、エクスポートパスが mynfs.example.com:/exports/myisos で、myisos という名前の NFS ISO ストレージドメインを作成します。API は (StorageDomain タイプの) 新規作成されたストレージドメインリソースについて以下の表現も返します。

<storage_domain href="/ovirt-engine/api/storagedomains/006" id="006">
  <name>myiso</name>
  <description>My ISOs</description>
  <available>42949672960</available>
  <committed>0</committed>
  <master>false</master>
  <status>unattached</status>
  <storage>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
    <type>nfs</type>
  </storage>
  <storage_format>v1</storage_format>
  <type>iso</type>
  <used>9663676416</used>
</storage_domain>

<storage_domain href="/ovirt-engine/api/storagedomains/006" id="006">
  <name>myiso</name>
  <description>My ISOs</description>
  <available>42949672960</available>
  <committed>0</committed>
  <master>false</master>
  <status>unattached</status>
  <storage>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
    <type>nfs</type>
  </storage>
  <storage_format>v1</storage_format>
  <type>iso</type>
  <used>9663676416</used>
</storage_domain>

Copy to Clipboard

Toggle word wrap

4.8. データセンターへのストレージドメインの割り当て
リンクのコピー

以下の例では、mydata および myisos ストレージドメインを Default データセンターにアタッチします。

mydata ストレージドメインをアタッチするには、以下のように要求を送信します。

POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

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

<storage_domain>
  <name>mydata</name>
</storage_domain>

<storage_domain>
  <name>mydata</name>
</storage_domain>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>mydata</name>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/datacenters/001/storagedomains

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>mydata</name>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/datacenters/001/storagedomains

Copy to Clipboard

Toggle word wrap

myisos ストレージドメインをアタッチするには、以下のような要求を送信します。

POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

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

<storage_domain>
  <name>myisos</name>
</storage_domain>

<storage_domain>
  <name>myisos</name>
</storage_domain>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>myisos</name>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/datacenters/001/storagedomains

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>myisos</name>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/datacenters/001/storagedomains

Copy to Clipboard

Toggle word wrap

4.9. 仮想マシンの作成
リンクのコピー

以下の例では、仮想化環境の Blank テンプレートをベースとして使用し、Default クラスターに myvm という名前の仮想マシンを作成します。また、要求は仮想マシンのメモリーを 512 MiB として定義し、ブートデバイスを仮想ハードディスクに設定します。

要求には、作成する仮想マシンを記述する Vm タイプのオブジェクトが含まれている必要があります。

POST /ovirt-engine/api/vms HTTP/1.1
Accept: application/xml
Content-type: application/xml

POST /ovirt-engine/api/vms HTTP/1.1
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

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

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
  <memory>536870912</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
</vm>

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
  <memory>536870912</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
</vm>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
  <memory>536870912</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
</vm>
' \
https://myengine.example.com/ovirt-engine/api/vms

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
  <memory>536870912</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
</vm>
' \
https://myengine.example.com/ovirt-engine/api/vms

Copy to Clipboard

Toggle word wrap

応答ボディーは、Vm タイプのオブジェクトです。

<vm href="/ovirt-engine/api/vms/007" id="007">
  <name>myvm</name>
  <link href="/ovirt-engine/api/vms/007/diskattachments" rel="diskattachments"/>
  <link href="/ovirt-engine/api/vms/007/nics" rel="nics"/>
  ...
  <cpu>
    <architecture>x86_64</architecture>
    <topology>
      <cores>1</cores>
      <sockets>1</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
  <memory>1073741824</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
    <type>other</type>
  </os>
  <type>desktop</type>
  <cluster href="/ovirt-engine/api/clusters/002" id="002"/>
  <status>down</status>
  <original_template href="/ovirt-engine/api/templates/000" id="00"/>
  <template href="/ovirt-engine/api/templates/000" id="000"/>
</vm>

<vm href="/ovirt-engine/api/vms/007" id="007">
  <name>myvm</name>
  <link href="/ovirt-engine/api/vms/007/diskattachments" rel="diskattachments"/>
  <link href="/ovirt-engine/api/vms/007/nics" rel="nics"/>
  ...
  <cpu>
    <architecture>x86_64</architecture>
    <topology>
      <cores>1</cores>
      <sockets>1</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
  <memory>1073741824</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
    <type>other</type>
  </os>
  <type>desktop</type>
  <cluster href="/ovirt-engine/api/clusters/002" id="002"/>
  <status>down</status>
  <original_template href="/ovirt-engine/api/templates/000" id="00"/>
  <template href="/ovirt-engine/api/templates/000" id="000"/>
</vm>

Copy to Clipboard

Toggle word wrap

4.10. 仮想マシン NIC の作成
リンクのコピー

以下の例では、サンプルの仮想マシンを ovirtmgmt ネットワークに接続するための仮想ネットワークインターフェイスを作成します。

要求は以下のようになります。

POST /ovirt-engine/api/vms/007/nics HTTP/1.1
Content-Type: application/xml
Accept: application/xml

POST /ovirt-engine/api/vms/007/nics HTTP/1.1
Content-Type: application/xml
Accept: application/xml

Copy to Clipboard

Toggle word wrap

リクエスト本文には、作成する NIC を記述する Nic タイプのオブジェクトが含まれている必要があります。

<nic>
  <name>mynic</name>
  <description>My network interface card</description>
</nic>

<nic>
  <name>mynic</name>
  <description>My network interface card</description>
</nic>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<nic>
  <name>mynic</name>
  <description>My network interface card</description>
</nic>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/nics

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<nic>
  <name>mynic</name>
  <description>My network interface card</description>
</nic>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/nics

Copy to Clipboard

Toggle word wrap

4.11. 仮想マシンディスクの作成
リンクのコピー

以下の例では、サンプルの仮想マシン用に 8 GiB の コピーオンライト ディスクを作成します。

要求は以下のようになります。

POST /ovirt-engine/api/vms/007/diskattachments HTTP/1.1
Content-Type: application/xml
Accept: application/xml

POST /ovirt-engine/api/vms/007/diskattachments HTTP/1.1
Content-Type: application/xml
Accept: application/xml

Copy to Clipboard

Toggle word wrap

リクエスト本文は DiskAttachment 型のオブジェクトで、ディスクとその仮想マシンへのアタッチ方法を記述してください。

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <active>true</active>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>8589934592</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <active>true</active>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>8589934592</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <active>true</active>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>8589934592</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/diskattachments

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <active>true</active>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>8589934592</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/diskattachments

Copy to Clipboard

Toggle word wrap

storage_domains 属性は、API に対して、ディスクを mydata ストレージドメインに保存するように指示します。

4.12. ISO イメージの仮想マシンへのアタッチ
リンクのコピー

次の仮想マシン例のブートメディアには、オペレーティングシステムのインストールに CD-ROM または DVD ISO イメージが必要です。この例では、CentOS 7 イメージを使用します。

仮想マシンが使用するには、myisos ISO ドメインで ISO イメージが利用可能でなければなりません。ImageTransfer を使用してイメージ転送を作成し、ImageTransfers を使用して ISO イメージをアップロードすることができます。

ISO イメージをアップロードしたら、API を使用して ISO ストレージドメインからファイルリストを要求できます。

GET /ovirt-engine/api/storagedomains/006/files HTTP/1.1
Accept: application/xml

GET /ovirt-engine/api/storagedomains/006/files HTTP/1.1
Accept: application/xml

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
https://myengine.example.com/ovirt-engine/api/storagedomains/006/files

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
https://myengine.example.com/ovirt-engine/api/storagedomains/006/files

Copy to Clipboard

Toggle word wrap

サーバーは、利用可能な ISO(または floppy) イメージごとに 1 つずつ、File タイプのオブジェクトリストを返します。

<files>
  <file href="..." id="CentOS-7-x86_64-Minimal.iso">
    <name>CentOS-7-x86_64-Minimal.iso</name>
  </file>
  ...
</files>

<files>
  <file href="..." id="CentOS-7-x86_64-Minimal.iso">
    <name>CentOS-7-x86_64-Minimal.iso</name>
  </file>
  ...
</files>

Copy to Clipboard

Toggle word wrap

API ユーザーは CentOS-7-x86_64-Minimal.iso を example 仮想マシンの例に割り当てます。ISO イメージの割り当ては、管理またはユーザーポータルアプリケーションで CD ボタンを使用するのと同じです。

要求は以下のようになります。

PUT /ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml

PUT /ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

リクエスト本文は、ISO(または floppy) イメージの識別子を示す内部 ファイル 属性が含まれる Cdrom タイプのオブジェクトである必要があります。

<cdrom>
  <file id="CentOS-7-x86_64-Minimal.iso"/>
</cdrom>

<cdrom>
  <file id="CentOS-7-x86_64-Minimal.iso"/>
</cdrom>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request PUT \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<cdrom>
  <file id="CentOS-7-x86_64-Minimal.iso"/>
</cdrom>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request PUT \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<cdrom>
  <file id="CentOS-7-x86_64-Minimal.iso"/>
</cdrom>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000

Copy to Clipboard

Toggle word wrap

詳細は、仮想マシンの CD-ROMS を管理するサービスのドキュメントを参照してください。

4.13. 仮想マシンの起動
リンクのコピー

仮想環境が完了し、仮想マシンには正常に動作させるのに必要なすべてのコンポーネントが含まれます。この例では、start メソッドを使用して仮想マシンを起動します。

要求は以下のようになります。

POST /ovirt-engine/api/vms/007/start HTTP/1.1
Accept: application/xml
Content-type: application/xml

POST /ovirt-engine/api/vms/007/start HTTP/1.1
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

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

<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>

<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>

Copy to Clipboard

Toggle word wrap

curl コマンドを使用した同じ要求。

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/start

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/start

Copy to Clipboard

Toggle word wrap

追加のリクエスト本文は、今回の起動のみ仮想マシンのブートデバイスを CD-ROM に設定します。これにより、仮想マシンが割り当てられた ISO イメージからオペレーティングシステムをインストールできます。ブートデバイスは、その後の起動時にディスクに戻ります。

第5章要求
リンクのコピー

このセクションでは、API で利用可能な全要求を列挙します。

POST /affinitylabels
GET /affinitylabels
GET /affinitylabels/{label:id}
PUT /affinitylabels/{label:id}
DELETE /affinitylabels/{label:id}
POST /affinitylabels/{label:id}/hosts
GET /affinitylabels/{label:id}/hosts
DELETE /affinitylabels/{label:id}/hosts/{host:id}
GET /affinitylabels/{label:id}/hosts/{host:id}
POST /affinitylabels/{label:id}/vms
GET /affinitylabels/{label:id}/vms
DELETE /affinitylabels/{label:id}/vms/{vm:id}
GET /affinitylabels/{label:id}/vms/{vm:id}
POST /bookmarks
GET /bookmarks
GET /bookmarks/{bookmark:id}
PUT /bookmarks/{bookmark:id}
DELETE /bookmarks/{bookmark:id}
GET /clusterlevels
GET /clusterlevels/{level:id}
GET /clusterlevels/{level:id}/clusterfeatures
GET /clusterlevels/{level:id}/clusterfeatures/{feature:id}
POST /clusters
GET /clusters
GET /clusters/{cluster:id}
PUT /clusters/{cluster:id}
DELETE /clusters/{cluster:id}
POST /clusters/{cluster:id}/affinitygroups
GET /clusters/{cluster:id}/affinitygroups
GET /clusters/{cluster:id}/affinitygroups/{group:id}
PUT /clusters/{cluster:id}/affinitygroups/{group:id}
DELETE /clusters/{cluster:id}/affinitygroups/{group:id}
POST /clusters/{cluster:id}/affinitygroups/{group:id}/hostlabels
GET /clusters/{cluster:id}/affinitygroups/{group:id}/hostlabels
DELETE /clusters/{cluster:id}/affinitygroups/{group:id}/hostlabels/{label:id}
POST /clusters/{cluster:id}/affinitygroups/{group:id}/hosts
GET /clusters/{cluster:id}/affinitygroups/{group:id}/hosts
DELETE /clusters/{cluster:id}/affinitygroups/{group:id}/hosts/{host:idorname}
POST /clusters/{cluster:id}/affinitygroups/{group:id}/vmlabels
GET /clusters/{cluster:id}/affinitygroups/{group:id}/vmlabels
DELETE /clusters/{cluster:id}/affinitygroups/{group:id}/vmlabels/{label:id}
POST /clusters/{cluster:id}/affinitygroups/{group:id}/vms
GET /clusters/{cluster:id}/affinitygroups/{group:id}/vms
DELETE /clusters/{cluster:id}/affinitygroups/{group:id}/vms/{vm:id}
POST /clusters/{cluster:id}/cpuprofiles
GET /clusters/{cluster:id}/cpuprofiles
GET /clusters/{cluster:id}/cpuprofiles/{profile:id}
DELETE /clusters/{cluster:id}/cpuprofiles/{profile:id}
GET /clusters/{cluster:id}/enabledfeatures
POST /clusters/{cluster:id}/enabledfeatures
GET /clusters/{cluster:id}/enabledfeatures/{feature:id}
DELETE /clusters/{cluster:id}/enabledfeatures/{feature:id}
GET /clusters/{cluster:id}/externalnetworkproviders
GET /clusters/{cluster:id}/glusterhooks
GET /clusters/{cluster:id}/glusterhooks/{hook:id}
DELETE /clusters/{cluster:id}/glusterhooks/{hook:id}
POST /clusters/{cluster:id}/glusterhooks/{hook:id}/disable
POST /clusters/{cluster:id}/glusterhooks/{hook:id}/enable
POST /clusters/{cluster:id}/glusterhooks/{hook:id}/resolve
POST /clusters/{cluster:id}/glustervolumes
GET /clusters/{cluster:id}/glustervolumes
GET /clusters/{cluster:id}/glustervolumes/{volume:id}
DELETE /clusters/{cluster:id}/glustervolumes/{volume:id}
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/getprofilestatistics
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
GET /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
DELETE /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/activate
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/migrate
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/stopmigrate
GET /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}
DELETE /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/replace
GET /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/statistics
GET /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/statistics/{statistic:id}
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/rebalance
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/resetalloptions
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/resetoption
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/setoption
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/start
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/startprofile
GET /clusters/{cluster:id}/glustervolumes/{volume:id}/statistics
GET /clusters/{cluster:id}/glustervolumes/{volume:id}/statistics/{statistic:id}
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/stop
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/stopprofile
POST /clusters/{cluster:id}/glustervolumes/{volume:id}/stoprebalance
GET /clusters/{cluster:id}/networkfilters
GET /clusters/{cluster:id}/networkfilters/{networkfilter:id}
POST /clusters/{cluster:id}/networks
GET /clusters/{cluster:id}/networks
GET /clusters/{cluster:id}/networks/{network:id}
DELETE /clusters/{cluster:id}/networks/{network:id}
PUT /clusters/{cluster:id}/networks/{network:id}
POST /clusters/{cluster:id}/permissions
GET /clusters/{cluster:id}/permissions
GET /clusters/{cluster:id}/permissions/{permission:id}
DELETE /clusters/{cluster:id}/permissions/{permission:id}
POST /clusters/{cluster:id}/refreshglusterhealstatus
POST /clusters/{cluster:id}/resetemulatedmachine
POST /clusters/{cluster:id}/syncallnetworks
POST /clusters/{cluster:id}/upgrade
POST /cpuprofiles
GET /cpuprofiles
GET /cpuprofiles/{profile:id}
PUT /cpuprofiles/{profile:id}
DELETE /cpuprofiles/{profile:id}
POST /cpuprofiles/{profile:id}/permissions
GET /cpuprofiles/{profile:id}/permissions
GET /cpuprofiles/{profile:id}/permissions/{permission:id}
DELETE /cpuprofiles/{profile:id}/permissions/{permission:id}
POST /datacenters
GET /datacenters
GET /datacenters/{datacenter:id}
PUT /datacenters/{datacenter:id}
DELETE /datacenters/{datacenter:id}
POST /datacenters/{datacenter:id}/cleanfinishedtasks
POST /datacenters/{datacenter:id}/clusters
GET /datacenters/{datacenter:id}/clusters
GET /datacenters/{datacenter:id}/clusters/{cluster:id}
PUT /datacenters/{datacenter:id}/clusters/{cluster:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}
PUT /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/hostlabels
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/hostlabels
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/hostlabels/{label:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/hosts
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/hosts
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/hosts/{host:idorname}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vmlabels
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vmlabels
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vmlabels/{label:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vms
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vms
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vms/{vm:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/cpuprofiles
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/cpuprofiles
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/cpuprofiles/{profile:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/cpuprofiles/{profile:id}
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/enabledfeatures
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/enabledfeatures
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/enabledfeatures/{feature:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/enabledfeatures/{feature:id}
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/externalnetworkproviders
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}/disable
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}/enable
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}/resolve
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/getprofilestatistics
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/activate
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/migrate
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/stopmigrate
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/replace
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/statistics
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/statistics/{statistic:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/rebalance
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/resetalloptions
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/resetoption
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/setoption
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/start
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/startprofile
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/statistics
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/statistics/{statistic:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/stop
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/stopprofile
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/stoprebalance
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/networkfilters
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/networkfilters/{networkfilter:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/networks
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/networks
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/networks/{network:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/networks/{network:id}
PUT /datacenters/{datacenter:id}/clusters/{cluster:id}/networks/{network:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/permissions
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/permissions
GET /datacenters/{datacenter:id}/clusters/{cluster:id}/permissions/{permission:id}
DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/permissions/{permission:id}
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/refreshglusterhealstatus
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/resetemulatedmachine
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/syncallnetworks
POST /datacenters/{datacenter:id}/clusters/{cluster:id}/upgrade
POST /datacenters/{datacenter:id}/iscsibonds
GET /datacenters/{datacenter:id}/iscsibonds
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}
PUT /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}
DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}
POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}
PUT /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}
DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}
POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/networklabels
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/networklabels
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/networklabels/{label:id}
DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/networklabels/{label:id}
POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/permissions
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/permissions
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/permissions/{permission:id}
DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/permissions/{permission:id}
POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}
DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}
POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}/permissions
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}/permissions
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}/permissions/{permission:id}
DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}/permissions/{permission:id}
POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections
GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections/{storageconnection:id}
PUT /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections/{storageconnection:id}
DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections/{storageconnection:id}
POST /datacenters/{datacenter:id}/networks
GET /datacenters/{datacenter:id}/networks
GET /datacenters/{datacenter:id}/networks/{network:id}
DELETE /datacenters/{datacenter:id}/networks/{network:id}
PUT /datacenters/{datacenter:id}/networks/{network:id}
POST /datacenters/{datacenter:id}/permissions
GET /datacenters/{datacenter:id}/permissions
GET /datacenters/{datacenter:id}/permissions/{permission:id}
DELETE /datacenters/{datacenter:id}/permissions/{permission:id}
POST /datacenters/{datacenter:id}/qoss
GET /datacenters/{datacenter:id}/qoss
GET /datacenters/{datacenter:id}/qoss/{qos:id}
PUT /datacenters/{datacenter:id}/qoss/{qos:id}
DELETE /datacenters/{datacenter:id}/qoss/{qos:id}
POST /datacenters/{datacenter:id}/quotas
GET /datacenters/{datacenter:id}/quotas
GET /datacenters/{datacenter:id}/quotas/{quota:id}
PUT /datacenters/{datacenter:id}/quotas/{quota:id}
DELETE /datacenters/{datacenter:id}/quotas/{quota:id}
POST /datacenters/{datacenter:id}/quotas/{quota:id}/permissions
GET /datacenters/{datacenter:id}/quotas/{quota:id}/permissions
GET /datacenters/{datacenter:id}/quotas/{quota:id}/permissions/{permission:id}
DELETE /datacenters/{datacenter:id}/quotas/{quota:id}/permissions/{permission:id}
POST /datacenters/{datacenter:id}/quotas/{quota:id}/quotaclusterlimits
GET /datacenters/{datacenter:id}/quotas/{quota:id}/quotaclusterlimits
GET /datacenters/{datacenter:id}/quotas/{quota:id}/quotaclusterlimits/{limit:id}
DELETE /datacenters/{datacenter:id}/quotas/{quota:id}/quotaclusterlimits/{limit:id}
POST /datacenters/{datacenter:id}/quotas/{quota:id}/quotastoragelimits
GET /datacenters/{datacenter:id}/quotas/{quota:id}/quotastoragelimits
GET /datacenters/{datacenter:id}/quotas/{quota:id}/quotastoragelimits/{limit:id}
DELETE /datacenters/{datacenter:id}/quotas/{quota:id}/quotastoragelimits/{limit:id}
POST /datacenters/{datacenter:id}/setmaster
POST /datacenters/{datacenter:id}/storagedomains
GET /datacenters/{datacenter:id}/storagedomains
GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}
DELETE /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/activate
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/deactivate
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks
GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks
PUT /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}
GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}
DELETE /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/copy
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/export
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/move
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/permissions
GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/permissions
GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/permissions/{permission:id}
DELETE /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/permissions/{permission:id}
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/register
POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/sparsify
GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/statistics
GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/statistics/{statistic:id}
POST /diskprofiles
GET /diskprofiles
GET /diskprofiles/{diskprofile:id}
PUT /diskprofiles/{diskprofile:id}
DELETE /diskprofiles/{diskprofile:id}
POST /diskprofiles/{diskprofile:id}/permissions
GET /diskprofiles/{diskprofile:id}/permissions
GET /diskprofiles/{diskprofile:id}/permissions/{permission:id}
DELETE /diskprofiles/{diskprofile:id}/permissions/{permission:id}
POST /disks
GET /disks
PUT /disks/{disk:id}
GET /disks/{disk:id}
DELETE /disks/{disk:id}
POST /disks/{disk:id}/convert
POST /disks/{disk:id}/copy
GET /disks/{disk:id}/disksnapshots
GET /disks/{disk:id}/disksnapshots/{snapshot:id}
DELETE /disks/{disk:id}/disksnapshots/{snapshot:id}
POST /disks/{disk:id}/export
POST /disks/{disk:id}/move
POST /disks/{disk:id}/permissions
GET /disks/{disk:id}/permissions
GET /disks/{disk:id}/permissions/{permission:id}
DELETE /disks/{disk:id}/permissions/{permission:id}
POST /disks/{disk:id}/reduce
POST /disks/{disk:id}/refreshlun
POST /disks/{disk:id}/sparsify
GET /disks/{disk:id}/statistics
GET /disks/{disk:id}/statistics/{statistic:id}
GET /domains
GET /domains/{domain:id}
GET /domains/{domain:id}/groups
GET /domains/{domain:id}/groups/{group:id}
GET /domains/{domain:id}/users
GET /domains/{domain:id}/users/{user:id}
POST /events
GET /events
POST /events/undelete
GET /events/{event:id}
DELETE /events/{event:id}
POST /externalhostproviders
GET /externalhostproviders
GET /externalhostproviders/{provider:id}
PUT /externalhostproviders/{provider:id}
DELETE /externalhostproviders/{provider:id}
GET /externalhostproviders/{provider:id}/certificates
GET /externalhostproviders/{provider:id}/certificates/{certificate:id}
GET /externalhostproviders/{provider:id}/computeresources
GET /externalhostproviders/{provider:id}/computeresources/{resource:id}
GET /externalhostproviders/{provider:id}/discoveredhosts
GET /externalhostproviders/{provider:id}/discoveredhosts/{host:id}
GET /externalhostproviders/{provider:id}/hostgroups
GET /externalhostproviders/{provider:id}/hostgroups/{group:id}
GET /externalhostproviders/{provider:id}/hosts
GET /externalhostproviders/{provider:id}/hosts/{host:id}
POST /externalhostproviders/{provider:id}/importcertificates
POST /externalhostproviders/{provider:id}/testconnectivity
POST /externaltemplateimports
POST /externalvmimports
POST /groups
GET /groups
GET /groups/{group:id}
DELETE /groups/{group:id}
POST /groups/{group:id}/permissions
GET /groups/{group:id}/permissions
GET /groups/{group:id}/permissions/{permission:id}
DELETE /groups/{group:id}/permissions/{permission:id}
GET /groups/{group:id}/roles
GET /groups/{group:id}/roles/{role:id}
DELETE /groups/{group:id}/roles/{role:id}
PUT /groups/{group:id}/roles/{role:id}
POST /groups/{group:id}/roles/{role:id}/permits
GET /groups/{group:id}/roles/{role:id}/permits
GET /groups/{group:id}/roles/{role:id}/permits/{permit:id}
DELETE /groups/{group:id}/roles/{role:id}/permits/{permit:id}
POST /groups/{group:id}/tags
GET /groups/{group:id}/tags
GET /groups/{group:id}/tags/{tag:id}
DELETE /groups/{group:id}/tags/{tag:id}
POST /hosts
GET /hosts
GET /hosts/{host:id}
PUT /hosts/{host:id}
DELETE /hosts/{host:id}
POST /hosts/{host:id}/activate
POST /hosts/{host:id}/affinitylabels
GET /hosts/{host:id}/affinitylabels
GET /hosts/{host:id}/affinitylabels/{label:id}
DELETE /hosts/{host:id}/affinitylabels/{label:id}
POST /hosts/{host:id}/approve
POST /hosts/{host:id}/commitnetconfig
POST /hosts/{host:id}/copyhostnetworks
GET /hosts/{host:id}/cpuunits
POST /hosts/{host:id}/deactivate
GET /hosts/{host:id}/devices
GET /hosts/{host:id}/devices/{device:id}
POST /hosts/{host:id}/discoveriscsi
POST /hosts/{host:id}/enrollcertificate
GET /hosts/{host:id}/externalnetworkproviderconfigurations
GET /hosts/{host:id}/externalnetworkproviderconfigurations/{configuration:id}
POST /hosts/{host:id}/fence
POST /hosts/{host:id}/fenceagents
GET /hosts/{host:id}/fenceagents
GET /hosts/{host:id}/fenceagents/{agent:id}
PUT /hosts/{host:id}/fenceagents/{agent:id}
DELETE /hosts/{host:id}/fenceagents/{agent:id}
POST /hosts/{host:id}/forceselectspm
GET /hosts/{host:id}/hooks
GET /hosts/{host:id}/hooks/{hook:id}
POST /hosts/{host:id}/install
POST /hosts/{host:id}/iscsidiscover
POST /hosts/{host:id}/iscsilogin
GET /hosts/{host:id}/katelloerrata
GET /hosts/{host:id}/katelloerrata/{katelloerratum:id}
POST /hosts/{host:id}/networkattachments
GET /hosts/{host:id}/networkattachments
GET /hosts/{host:id}/networkattachments/{attachment:id}
PUT /hosts/{host:id}/networkattachments/{attachment:id}
DELETE /hosts/{host:id}/networkattachments/{attachment:id}
GET /hosts/{host:id}/nics
GET /hosts/{host:id}/nics/{nic:id}
GET /hosts/{host:id}/nics/{nic:id}/linklayerdiscoveryprotocolelements
POST /hosts/{host:id}/nics/{nic:id}/networkattachments
GET /hosts/{host:id}/nics/{nic:id}/networkattachments
GET /hosts/{host:id}/nics/{nic:id}/networkattachments/{attachment:id}
PUT /hosts/{host:id}/nics/{nic:id}/networkattachments/{attachment:id}
DELETE /hosts/{host:id}/nics/{nic:id}/networkattachments/{attachment:id}
POST /hosts/{host:id}/nics/{nic:id}/networklabels
GET /hosts/{host:id}/nics/{nic:id}/networklabels
GET /hosts/{host:id}/nics/{nic:id}/networklabels/{label:id}
DELETE /hosts/{host:id}/nics/{nic:id}/networklabels/{label:id}
GET /hosts/{host:id}/nics/{nic:id}/statistics
GET /hosts/{host:id}/nics/{nic:id}/statistics/{statistic:id}
POST /hosts/{host:id}/nics/{nic:id}/updatevirtualfunctionsconfiguration
POST /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowedlabels
GET /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowedlabels
GET /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowedlabels/{label:id}
DELETE /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowedlabels/{label:id}
POST /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowednetworks
GET /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowednetworks
GET /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowednetworks/{network:id}
DELETE /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowednetworks/{network:id}
GET /hosts/{host:id}/numanodes
GET /hosts/{host:id}/numanodes/{node:id}
GET /hosts/{host:id}/numanodes/{node:id}/statistics
GET /hosts/{host:id}/numanodes/{node:id}/statistics/{statistic:id}
POST /hosts/{host:id}/permissions
GET /hosts/{host:id}/permissions
GET /hosts/{host:id}/permissions/{permission:id}
DELETE /hosts/{host:id}/permissions/{permission:id}
POST /hosts/{host:id}/refresh
POST /hosts/{host:id}/setupnetworks
GET /hosts/{host:id}/statistics
GET /hosts/{host:id}/statistics/{statistic:id}
GET /hosts/{host:id}/storage
GET /hosts/{host:id}/storage/{storage:id}
POST /hosts/{host:id}/storageconnectionextensions
GET /hosts/{host:id}/storageconnectionextensions
GET /hosts/{host:id}/storageconnectionextensions/{storageconnectionextension:id}
PUT /hosts/{host:id}/storageconnectionextensions/{storageconnectionextension:id}
DELETE /hosts/{host:id}/storageconnectionextensions/{storageconnectionextension:id}
POST /hosts/{host:id}/syncallnetworks
POST /hosts/{host:id}/tags
GET /hosts/{host:id}/tags
GET /hosts/{host:id}/tags/{tag:id}
DELETE /hosts/{host:id}/tags/{tag:id}
GET /hosts/{host:id}/unmanagednetworks
GET /hosts/{host:id}/unmanagednetworks/{unmanagednetwork:id}
DELETE /hosts/{host:id}/unmanagednetworks/{unmanagednetwork:id}
POST /hosts/{host:id}/unregisteredstoragedomainsdiscover
POST /hosts/{host:id}/upgrade
POST /hosts/{host:id}/upgradecheck
GET /icons
GET /icons/{icon:id}
POST /imagetransfers
GET /imagetransfers
GET /imagetransfers/{imagetransfer:id}
POST /imagetransfers/{imagetransfer:id}/cancel
POST /imagetransfers/{imagetransfer:id}/extend
POST /imagetransfers/{imagetransfer:id}/finalize
POST /imagetransfers/{imagetransfer:id}/pause
POST /imagetransfers/{imagetransfer:id}/resume
POST /instancetypes
GET /instancetypes
GET /instancetypes/{instancetype:id}
PUT /instancetypes/{instancetype:id}
DELETE /instancetypes/{instancetype:id}
POST /instancetypes/{instancetype:id}/graphicsconsoles
GET /instancetypes/{instancetype:id}/graphicsconsoles
GET /instancetypes/{instancetype:id}/graphicsconsoles/{console:id}
DELETE /instancetypes/{instancetype:id}/graphicsconsoles/{console:id}
POST /instancetypes/{instancetype:id}/nics
GET /instancetypes/{instancetype:id}/nics
GET /instancetypes/{instancetype:id}/nics/{nic:id}
PUT /instancetypes/{instancetype:id}/nics/{nic:id}
DELETE /instancetypes/{instancetype:id}/nics/{nic:id}
POST /instancetypes/{instancetype:id}/watchdogs
GET /instancetypes/{instancetype:id}/watchdogs
GET /instancetypes/{instancetype:id}/watchdogs/{watchdog:id}
PUT /instancetypes/{instancetype:id}/watchdogs/{watchdog:id}
DELETE /instancetypes/{instancetype:id}/watchdogs/{watchdog:id}
POST /jobs
GET /jobs
GET /jobs/{job:id}
POST /jobs/{job:id}/clear
POST /jobs/{job:id}/end
POST /jobs/{job:id}/steps
GET /jobs/{job:id}/steps
GET /jobs/{job:id}/steps/{step:id}
POST /jobs/{job:id}/steps/{step:id}/end
GET /jobs/{job:id}/steps/{step:id}/statistics
GET /jobs/{job:id}/steps/{step:id}/statistics/{statistic:id}
GET /katelloerrata
GET /katelloerrata/{katelloerratum:id}
POST /macpools
GET /macpools
GET /macpools/{macpool:id}
PUT /macpools/{macpool:id}
DELETE /macpools/{macpool:id}
POST /macpools/{macpool:id}/permissions
GET /macpools/{macpool:id}/permissions
GET /macpools/{macpool:id}/permissions/{permission:id}
DELETE /macpools/{macpool:id}/permissions/{permission:id}
GET /networkfilters
GET /networkfilters/{networkfilter:id}
POST /networks
GET /networks
GET /networks/{network:id}
PUT /networks/{network:id}
DELETE /networks/{network:id}
POST /networks/{network:id}/networklabels
GET /networks/{network:id}/networklabels
GET /networks/{network:id}/networklabels/{label:id}
DELETE /networks/{network:id}/networklabels/{label:id}
POST /networks/{network:id}/permissions
GET /networks/{network:id}/permissions
GET /networks/{network:id}/permissions/{permission:id}
DELETE /networks/{network:id}/permissions/{permission:id}
POST /networks/{network:id}/vnicprofiles
GET /networks/{network:id}/vnicprofiles
GET /networks/{network:id}/vnicprofiles/{profile:id}
DELETE /networks/{network:id}/vnicprofiles/{profile:id}
POST /networks/{network:id}/vnicprofiles/{profile:id}/permissions
GET /networks/{network:id}/vnicprofiles/{profile:id}/permissions
GET /networks/{network:id}/vnicprofiles/{profile:id}/permissions/{permission:id}
DELETE /networks/{network:id}/vnicprofiles/{profile:id}/permissions/{permission:id}
POST /openstackimageproviders
GET /openstackimageproviders
GET /openstackimageproviders/{provider:id}
PUT /openstackimageproviders/{provider:id}
DELETE /openstackimageproviders/{provider:id}
GET /openstackimageproviders/{provider:id}/certificates
GET /openstackimageproviders/{provider:id}/certificates/{certificate:id}
GET /openstackimageproviders/{provider:id}/images
GET /openstackimageproviders/{provider:id}/images/\{image\:id}
POST /openstackimageproviders/{provider:id}/images/\{image\:id}/import
POST /openstackimageproviders/{provider:id}/importcertificates
POST /openstackimageproviders/{provider:id}/testconnectivity
POST /openstacknetworkproviders
GET /openstacknetworkproviders
GET /openstacknetworkproviders/{provider:id}
PUT /openstacknetworkproviders/{provider:id}
DELETE /openstacknetworkproviders/{provider:id}
GET /openstacknetworkproviders/{provider:id}/certificates
GET /openstacknetworkproviders/{provider:id}/certificates/{certificate:id}
POST /openstacknetworkproviders/{provider:id}/importcertificates
GET /openstacknetworkproviders/{provider:id}/networks
GET /openstacknetworkproviders/{provider:id}/networks/{network:id}
POST /openstacknetworkproviders/{provider:id}/networks/{network:id}/import
POST /openstacknetworkproviders/{provider:id}/networks/{network:id}/subnets
GET /openstacknetworkproviders/{provider:id}/networks/{network:id}/subnets
GET /openstacknetworkproviders/{provider:id}/networks/{network:id}/subnets/{subnet:id}
DELETE /openstacknetworkproviders/{provider:id}/networks/{network:id}/subnets/{subnet:id}
POST /openstacknetworkproviders/{provider:id}/testconnectivity
POST /openstackvolumeproviders
GET /openstackvolumeproviders
GET /openstackvolumeproviders/{provider:id}
PUT /openstackvolumeproviders/{provider:id}
DELETE /openstackvolumeproviders/{provider:id}
POST /openstackvolumeproviders/{provider:id}/authenticationkeys
GET /openstackvolumeproviders/{provider:id}/authenticationkeys
GET /openstackvolumeproviders/{provider:id}/authenticationkeys/{key:id}
PUT /openstackvolumeproviders/{provider:id}/authenticationkeys/{key:id}
DELETE /openstackvolumeproviders/{provider:id}/authenticationkeys/{key:id}
GET /openstackvolumeproviders/{provider:id}/certificates
GET /openstackvolumeproviders/{provider:id}/certificates/{certificate:id}
POST /openstackvolumeproviders/{provider:id}/importcertificates
POST /openstackvolumeproviders/{provider:id}/testconnectivity
GET /openstackvolumeproviders/{provider:id}/volumetypes
GET /openstackvolumeproviders/{provider:id}/volumetypes/{type:id}
GET /operatingsystems
GET /operatingsystems/{operatingsystem:id}
GET /options/{option:id}
POST /permissions
GET /permissions
GET /permissions/{permission:id}
DELETE /permissions/{permission:id}
POST /roles
GET /roles
GET /roles/{role:id}
DELETE /roles/{role:id}
PUT /roles/{role:id}
POST /roles/{role:id}/permits
GET /roles/{role:id}/permits
GET /roles/{role:id}/permits/{permit:id}
DELETE /roles/{role:id}/permits/{permit:id}
POST /schedulingpolicies
GET /schedulingpolicies
GET /schedulingpolicies/{policy:id}
PUT /schedulingpolicies/{policy:id}
DELETE /schedulingpolicies/{policy:id}
POST /schedulingpolicies/{policy:id}/balances
GET /schedulingpolicies/{policy:id}/balances
GET /schedulingpolicies/{policy:id}/balances/{balance:id}
DELETE /schedulingpolicies/{policy:id}/balances/{balance:id}
POST /schedulingpolicies/{policy:id}/filters
GET /schedulingpolicies/{policy:id}/filters
GET /schedulingpolicies/{policy:id}/filters/{filter:id}
DELETE /schedulingpolicies/{policy:id}/filters/{filter:id}
POST /schedulingpolicies/{policy:id}/weights
GET /schedulingpolicies/{policy:id}/weights
GET /schedulingpolicies/{policy:id}/weights/{weight:id}
DELETE /schedulingpolicies/{policy:id}/weights/{weight:id}
GET /schedulingpolicyunits
GET /schedulingpolicyunits/{unit:id}
DELETE /schedulingpolicyunits/{unit:id}
POST /storageconnections
GET /storageconnections
GET /storageconnections/{storageconnection:id}
PUT /storageconnections/{storageconnection:id}
DELETE /storageconnections/{storageconnection:id}
POST /storagedomains
GET /storagedomains
GET /storagedomains/{storagedomain:id}
PUT /storagedomains/{storagedomain:id}
DELETE /storagedomains/{storagedomain:id}
POST /storagedomains/{storagedomain:id}/diskprofiles
GET /storagedomains/{storagedomain:id}/diskprofiles
GET /storagedomains/{storagedomain:id}/diskprofiles/{profile:id}
DELETE /storagedomains/{storagedomain:id}/diskprofiles/{profile:id}
POST /storagedomains/{storagedomain:id}/disks
GET /storagedomains/{storagedomain:id}/disks
PUT /storagedomains/{storagedomain:id}/disks/{disk:id}
GET /storagedomains/{storagedomain:id}/disks/{disk:id}
DELETE /storagedomains/{storagedomain:id}/disks/{disk:id}
POST /storagedomains/{storagedomain:id}/disks/{disk:id}/copy
POST /storagedomains/{storagedomain:id}/disks/{disk:id}/export
POST /storagedomains/{storagedomain:id}/disks/{disk:id}/move
POST /storagedomains/{storagedomain:id}/disks/{disk:id}/permissions
GET /storagedomains/{storagedomain:id}/disks/{disk:id}/permissions
GET /storagedomains/{storagedomain:id}/disks/{disk:id}/permissions/{permission:id}
DELETE /storagedomains/{storagedomain:id}/disks/{disk:id}/permissions/{permission:id}
POST /storagedomains/{storagedomain:id}/disks/{disk:id}/reduce
POST /storagedomains/{storagedomain:id}/disks/{disk:id}/sparsify
GET /storagedomains/{storagedomain:id}/disks/{disk:id}/statistics
GET /storagedomains/{storagedomain:id}/disks/{disk:id}/statistics/{statistic:id}
GET /storagedomains/{storagedomain:id}/disksnapshots
GET /storagedomains/{storagedomain:id}/disksnapshots/{snapshot:id}
DELETE /storagedomains/{storagedomain:id}/disksnapshots/{snapshot:id}
GET /storagedomains/{storagedomain:id}/files
GET /storagedomains/{storagedomain:id}/files/{file:id}
GET /storagedomains/{storagedomain:id}/images
GET /storagedomains/{storagedomain:id}/images/\{image\:id}
POST /storagedomains/{storagedomain:id}/images/\{image\:id}/import
POST /storagedomains/{storagedomain:id}/isattached
POST /storagedomains/{storagedomain:id}/permissions
GET /storagedomains/{storagedomain:id}/permissions
GET /storagedomains/{storagedomain:id}/permissions/{permission:id}
DELETE /storagedomains/{storagedomain:id}/permissions/{permission:id}
POST /storagedomains/{storagedomain:id}/reduceluns
POST /storagedomains/{storagedomain:id}/refreshluns
POST /storagedomains/{storagedomain:id}/storageconnections
GET /storagedomains/{storagedomain:id}/storageconnections
GET /storagedomains/{storagedomain:id}/storageconnections/{connection:id}
DELETE /storagedomains/{storagedomain:id}/storageconnections/{connection:id}
GET /storagedomains/{storagedomain:id}/templates
GET /storagedomains/{storagedomain:id}/templates/{template:id}
DELETE /storagedomains/{storagedomain:id}/templates/{template:id}
GET /storagedomains/{storagedomain:id}/templates/{template:id}/disks
GET /storagedomains/{storagedomain:id}/templates/{template:id}/disks/{disk:id}
POST /storagedomains/{storagedomain:id}/templates/{template:id}/import
POST /storagedomains/{storagedomain:id}/templates/{template:id}/register
POST /storagedomains/{storagedomain:id}/updateovfstore
GET /storagedomains/{storagedomain:id}/vms
GET /storagedomains/{storagedomain:id}/vms/{vm:id}
DELETE /storagedomains/{storagedomain:id}/vms/{vm:id}
GET /storagedomains/{storagedomain:id}/vms/{vm:id}/diskattachments
GET /storagedomains/{storagedomain:id}/vms/{vm:id}/diskattachments/{attachment:id}
GET /storagedomains/{storagedomain:id}/vms/{vm:id}/disks
GET /storagedomains/{storagedomain:id}/vms/{vm:id}/disks/{disk:id}
POST /storagedomains/{storagedomain:id}/vms/{vm:id}/import
POST /storagedomains/{storagedomain:id}/vms/{vm:id}/register
POST /tags
GET /tags
GET /tags/{tag:id}
PUT /tags/{tag:id}
DELETE /tags/{tag:id}
POST /templates
GET /templates
GET /templates/{template:id}
PUT /templates/{template:id}
DELETE /templates/{template:id}
GET /templates/{template:id}/cdroms
GET /templates/{template:id}/cdroms/{cdrom:id}
GET /templates/{template:id}/diskattachments
GET /templates/{template:id}/diskattachments/{attachment:id}
DELETE /templates/{template:id}/diskattachments/{attachment:id}
POST /templates/{template:id}/export
POST /templates/{template:id}/graphicsconsoles
GET /templates/{template:id}/graphicsconsoles
GET /templates/{template:id}/graphicsconsoles/{console:id}
DELETE /templates/{template:id}/graphicsconsoles/{console:id}
POST /templates/{template:id}/mediateddevices
GET /templates/{template:id}/mediateddevices
GET /templates/{template:id}/mediateddevices/{device:id}
PUT /templates/{template:id}/mediateddevices/{device:id}
DELETE /templates/{template:id}/mediateddevices/{device:id}
POST /templates/{template:id}/nics
GET /templates/{template:id}/nics
GET /templates/{template:id}/nics/{nic:id}
PUT /templates/{template:id}/nics/{nic:id}
DELETE /templates/{template:id}/nics/{nic:id}
POST /templates/{template:id}/permissions
GET /templates/{template:id}/permissions
GET /templates/{template:id}/permissions/{permission:id}
DELETE /templates/{template:id}/permissions/{permission:id}
POST /templates/{template:id}/tags
GET /templates/{template:id}/tags
GET /templates/{template:id}/tags/{tag:id}
DELETE /templates/{template:id}/tags/{tag:id}
POST /templates/{template:id}/watchdogs
GET /templates/{template:id}/watchdogs
GET /templates/{template:id}/watchdogs/{watchdog:id}
PUT /templates/{template:id}/watchdogs/{watchdog:id}
DELETE /templates/{template:id}/watchdogs/{watchdog:id}
POST /users
GET /users
GET /users/{user:id}
PUT /users/{user:id}
DELETE /users/{user:id}
POST /users/{user:id}/eventsubscriptions
GET /users/{user:id}/eventsubscriptions
GET /users/{user:id}/eventsubscriptions/{eventsubscription:id}
DELETE /users/{user:id}/eventsubscriptions/{eventsubscription:id}
GET /users/{user:id}/groups
POST /users/{user:id}/options
GET /users/{user:id}/options
GET /users/{user:id}/options/{option:id}
DELETE /users/{user:id}/options/{option:id}
POST /users/{user:id}/permissions
GET /users/{user:id}/permissions
GET /users/{user:id}/permissions/{permission:id}
DELETE /users/{user:id}/permissions/{permission:id}
GET /users/{user:id}/roles
GET /users/{user:id}/roles/{role:id}
DELETE /users/{user:id}/roles/{role:id}
PUT /users/{user:id}/roles/{role:id}
POST /users/{user:id}/roles/{role:id}/permits
GET /users/{user:id}/roles/{role:id}/permits
GET /users/{user:id}/roles/{role:id}/permits/{permit:id}
DELETE /users/{user:id}/roles/{role:id}/permits/{permit:id}
POST /users/{user:id}/sshpublickeys
GET /users/{user:id}/sshpublickeys
GET /users/{user:id}/sshpublickeys/{key:id}
PUT /users/{user:id}/sshpublickeys/{key:id}
DELETE /users/{user:id}/sshpublickeys/{key:id}
POST /users/{user:id}/tags
GET /users/{user:id}/tags
GET /users/{user:id}/tags/{tag:id}
DELETE /users/{user:id}/tags/{tag:id}
POST /vmpools
GET /vmpools
GET /vmpools/{pool:id}
PUT /vmpools/{pool:id}
DELETE /vmpools/{pool:id}
POST /vmpools/{pool:id}/allocatevm
POST /vmpools/{pool:id}/permissions
GET /vmpools/{pool:id}/permissions
GET /vmpools/{pool:id}/permissions/{permission:id}
DELETE /vmpools/{pool:id}/permissions/{permission:id}
POST /vms
GET /vms
GET /vms/{vm:id}
PUT /vms/{vm:id}
DELETE /vms/{vm:id}
POST /vms/{vm:id}/affinitylabels
GET /vms/{vm:id}/affinitylabels
GET /vms/{vm:id}/affinitylabels/{label:id}
DELETE /vms/{vm:id}/affinitylabels/{label:id}
GET /vms/{vm:id}/applications
GET /vms/{vm:id}/applications/{application:id}
POST /vms/{vm:id}/autopincpuandnumanodes
POST /vms/{vm:id}/backups
GET /vms/{vm:id}/backups
GET /vms/{vm:id}/backups/{backup:id}
GET /vms/{vm:id}/backups/{backup:id}/disks
GET /vms/{vm:id}/backups/{backup:id}/disks/{disk:id}
POST /vms/{vm:id}/backups/{backup:id}/finalize
POST /vms/{vm:id}/cancelmigration
POST /vms/{vm:id}/cdroms
GET /vms/{vm:id}/cdroms
GET /vms/{vm:id}/cdroms/{cdrom:id}
PUT /vms/{vm:id}/cdroms/{cdrom:id}
GET /vms/{vm:id}/checkpoints
GET /vms/{vm:id}/checkpoints/{checkpoint:id}
DELETE /vms/{vm:id}/checkpoints/{checkpoint:id}
GET /vms/{vm:id}/checkpoints/{checkpoint:id}/disks
GET /vms/{vm:id}/checkpoints/{checkpoint:id}/disks/{disk:id}
POST /vms/{vm:id}/clone
POST /vms/{vm:id}/commitsnapshot
POST /vms/{vm:id}/detach
POST /vms/{vm:id}/diskattachments
GET /vms/{vm:id}/diskattachments
GET /vms/{vm:id}/diskattachments/{attachment:id}
DELETE /vms/{vm:id}/diskattachments/{attachment:id}
PUT /vms/{vm:id}/diskattachments/{attachment:id}
POST /vms/{vm:id}/export
POST /vms/{vm:id}/freezefilesystems
POST /vms/{vm:id}/graphicsconsoles
GET /vms/{vm:id}/graphicsconsoles
GET /vms/{vm:id}/graphicsconsoles/{console:id}
DELETE /vms/{vm:id}/graphicsconsoles/{console:id}
POST /vms/{vm:id}/graphicsconsoles/{console:id}/proxyticket
POST /vms/{vm:id}/graphicsconsoles/{console:id}/remoteviewerconnectionfile
POST /vms/{vm:id}/graphicsconsoles/{console:id}/ticket
POST /vms/{vm:id}/hostdevices
GET /vms/{vm:id}/hostdevices
GET /vms/{vm:id}/hostdevices/{device:id}
DELETE /vms/{vm:id}/hostdevices/{device:id}
GET /vms/{vm:id}/katelloerrata
GET /vms/{vm:id}/katelloerrata/{katelloerratum:id}
POST /vms/{vm:id}/logon
POST /vms/{vm:id}/maintenance
POST /vms/{vm:id}/mediateddevices
GET /vms/{vm:id}/mediateddevices
GET /vms/{vm:id}/mediateddevices/{device:id}
PUT /vms/{vm:id}/mediateddevices/{device:id}
DELETE /vms/{vm:id}/mediateddevices/{device:id}
POST /vms/{vm:id}/migrate
POST /vms/{vm:id}/nics
GET /vms/{vm:id}/nics
GET /vms/{vm:id}/nics/{nic:id}
PUT /vms/{vm:id}/nics/{nic:id}
DELETE /vms/{vm:id}/nics/{nic:id}
POST /vms/{vm:id}/nics/{nic:id}/activate
POST /vms/{vm:id}/nics/{nic:id}/deactivate
GET /vms/{vm:id}/nics/{nic:id}/networkfilterparameters
POST /vms/{vm:id}/nics/{nic:id}/networkfilterparameters
GET /vms/{vm:id}/nics/{nic:id}/networkfilterparameters/{parameter:id}
PUT /vms/{vm:id}/nics/{nic:id}/networkfilterparameters/{parameter:id}
DELETE /vms/{vm:id}/nics/{nic:id}/networkfilterparameters/{parameter:id}
GET /vms/{vm:id}/nics/{nic:id}/reporteddevices
GET /vms/{vm:id}/nics/{nic:id}/reporteddevices/{reporteddevice:id}
GET /vms/{vm:id}/nics/{nic:id}/statistics
GET /vms/{vm:id}/nics/{nic:id}/statistics/{statistic:id}
POST /vms/{vm:id}/numanodes
GET /vms/{vm:id}/numanodes
GET /vms/{vm:id}/numanodes/{node:id}
PUT /vms/{vm:id}/numanodes/{node:id}
DELETE /vms/{vm:id}/numanodes/{node:id}
POST /vms/{vm:id}/permissions
GET /vms/{vm:id}/permissions
GET /vms/{vm:id}/permissions/{permission:id}
DELETE /vms/{vm:id}/permissions/{permission:id}
POST /vms/{vm:id}/previewsnapshot
POST /vms/{vm:id}/reboot
POST /vms/{vm:id}/reordermacaddresses
GET /vms/{vm:id}/reporteddevices
GET /vms/{vm:id}/reporteddevices/{reporteddevice:id}
POST /vms/{vm:id}/reset
POST /vms/{vm:id}/screenshot
GET /vms/{vm:id}/sessions
GET /vms/{vm:id}/sessions/{session:id}
POST /vms/{vm:id}/shutdown
POST /vms/{vm:id}/snapshots
GET /vms/{vm:id}/snapshots
GET /vms/{vm:id}/snapshots/{snapshot:id}
DELETE /vms/{vm:id}/snapshots/{snapshot:id}
GET /vms/{vm:id}/snapshots/{snapshot:id}/cdroms
GET /vms/{vm:id}/snapshots/{snapshot:id}/cdroms/{cdrom:id}
GET /vms/{vm:id}/snapshots/{snapshot:id}/disks
GET /vms/{vm:id}/snapshots/{snapshot:id}/disks/{disk:id}
GET /vms/{vm:id}/snapshots/{snapshot:id}/nics
GET /vms/{vm:id}/snapshots/{snapshot:id}/nics/{nic:id}
POST /vms/{vm:id}/snapshots/{snapshot:id}/restore
POST /vms/{vm:id}/start
GET /vms/{vm:id}/statistics
GET /vms/{vm:id}/statistics/{statistic:id}
POST /vms/{vm:id}/stop
POST /vms/{vm:id}/suspend
POST /vms/{vm:id}/tags
GET /vms/{vm:id}/tags
GET /vms/{vm:id}/tags/{tag:id}
DELETE /vms/{vm:id}/tags/{tag:id}
POST /vms/{vm:id}/thawfilesystems
POST /vms/{vm:id}/ticket
POST /vms/{vm:id}/undosnapshot
POST /vms/{vm:id}/watchdogs
GET /vms/{vm:id}/watchdogs
GET /vms/{vm:id}/watchdogs/{watchdog:id}
PUT /vms/{vm:id}/watchdogs/{watchdog:id}
DELETE /vms/{vm:id}/watchdogs/{watchdog:id}
POST /vnicprofiles
GET /vnicprofiles
GET /vnicprofiles/{profile:id}
PUT /vnicprofiles/{profile:id}
DELETE /vnicprofiles/{profile:id}
POST /vnicprofiles/{profile:id}/permissions
GET /vnicprofiles/{profile:id}/permissions
GET /vnicprofiles/{profile:id}/permissions/{permission:id}
DELETE /vnicprofiles/{profile:id}/permissions/{permission:id}

第6章サービス
リンクのコピー

このセクションでは、API で利用可能なすべてのサービスを説明します。

6.1. AffinityGroup
リンクのコピー

このサービスは単一のアフィニティーグループを管理します。

Expand

表6.1 メソッドの概要
名前	Summary
`get`	アフィニティーグループの詳細を取得します。
`remove`	アフィニティーグループを削除します。
`update`	アフィニティーグループを更新します。

6.1.1. get GET
リンクのコピー

アフィニティーグループの詳細を取得します。

<affinity_group id="00000000-0000-0000-0000-000000000000">
  <name>AF_GROUP_001</name>
  <cluster id="00000000-0000-0000-0000-000000000000"/>
  <positive>true</positive>
  <enforcing>true</enforcing>
</affinity_group>

<affinity_group id="00000000-0000-0000-0000-000000000000">
  <name>AF_GROUP_001</name>
  <cluster id="00000000-0000-0000-0000-000000000000"/>
  <positive>true</positive>
  <enforcing>true</enforcing>
</affinity_group>

Copy to Clipboard

Toggle word wrap

Expand

表6.2 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`group`	AffinityGroup	Out	アフィニティーグループ。

6.1.1.1. follow
リンクのコピー

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

6.1.2. remove DELETE
リンクのコピー

アフィニティーグループを削除します。

DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456

DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456

Copy to Clipboard

Toggle word wrap

Expand

表6.3 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.1.3. update PUT
リンクのコピー

アフィニティーグループを更新します。

Expand

表6.4 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`group`	AffinityGroup	In/Out	アフィニティーグループ。

6.2. AffinityGroupHost
リンクのコピー

このサービスは、1 台のホストを管理し、アフィニティーグループの割り当てを行います。

Expand

表6.5 メソッドの概要
名前	Summary
`remove`	アフィニティーグループからホストを削除します。

6.2.1. remove DELETE
リンクのコピー

アフィニティーグループからホストを削除します。

Expand

表6.6 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.3. AffinityGroupHostLabel
リンクのコピー

このサービスは、アフィニティーグループに割り当てられた単一のホストラベルを管理します。

Expand

表6.7 メソッドの概要
名前	Summary
`remove`	アフィニティーグループからこのラベルを削除します。

6.3.1. remove DELETE
リンクのコピー

アフィニティーグループからこのラベルを削除します。

Expand

表6.8 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.4. AffinityGroupHostLabels
リンクのコピー

このサービスは、アフィニティーグループに割り当てられたすべてのホストラベルのコレクションを管理します。

Expand

表6.9 メソッドの概要
名前	Summary
`add`	アフィニティーグループにホストラベルを追加します。
`list`	このアフィニティーグループに割り当てられたすべてのホストラベルをリスト表示します。

6.4.1. add POST
リンクのコピー

アフィニティーグループにホストラベルを追加します。

たとえば、ラベル 789 をクラスター 123 のアフィニティーグループ 456 に追加するには、以下のような要求を送信します。

POST /ovirt-engine/api/clusters/123/affinitygroups/456/hostlabels

POST /ovirt-engine/api/clusters/123/affinitygroups/456/hostlabels

Copy to Clipboard

Toggle word wrap

以下のボディーを使用します。

<affinity_label id="789"/>

<affinity_label id="789"/>

Copy to Clipboard

Toggle word wrap

Expand

表6.10 パラメーターの概要
名前	型	方向	Summary
`ラベル`	AffinityLabel	In/Out	アフィニティーグループに追加する AffinityLabel オブジェクト。

6.4.2. list GET
リンクのコピー

このアフィニティーグループに割り当てられたすべてのホストラベルをリスト表示します。

返されるラベルの順序は保証されません。

Expand

表6.11 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`labels`	AffinityLabel[]	Out	アフィニティーグループに割り当てられたホストラベル。
`max`	Integer	In	返すホストラベルの最大数を設定します。

6.4.2.1. follow
リンクのコピー

6.4.2.2. max
リンクのコピー

返すホストラベルの最大数を設定します。指定されていない場合、すべてのラベルが返されます。

6.5. AffinityGroupHosts
リンクのコピー

このサービスは、アフィニティーグループに割り当てられたすべてのホストのコレクションを管理します。

Expand

表6.12 メソッドの概要
名前	Summary
`add`	アフィニティーグループにホストを追加します。
`list`	このアフィニティーグループに割り当てられたホストをリスト表示します。

6.5.1. add POST
リンクのコピー

アフィニティーグループにホストを追加します。

たとえば、ホスト 789 をクラスター 123 のアフィニティーグループ 456 に追加するには、以下のような要求を送信します。

POST /ovirt-engine/api/clusters/123/affinitygroups/456/hosts

POST /ovirt-engine/api/clusters/123/affinitygroups/456/hosts

Copy to Clipboard

Toggle word wrap

以下のボディーを使用します。

<host id="789"/>

<host id="789"/>

Copy to Clipboard

Toggle word wrap

Expand

表6.13 パラメーターの概要
名前	型	方向	Summary
`host`	ホスト	In/Out	アフィニティーグループに追加するホスト。

6.5.2. list GET
リンクのコピー

このアフィニティーグループに割り当てられたホストをリスト表示します。

返されるホストの順序は保証されません。

Expand

表6.14 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hosts`	Host[]	Out	このアフィニティーグループに割り当てられたホストのリスト。
`max`	Integer	In	返すホストの最大数を設定します。

6.5.2.1. follow
リンクのコピー

6.5.2.2. max
リンクのコピー

返すホストの最大数を設定します。指定されていない場合は、すべてのホストが返されます。

6.6. AffinityGroupVm
リンクのコピー

このサービスは単一の仮想マシンを管理し、アフィニティーグループの割り当てを管理します。

Expand

表6.15 メソッドの概要
名前	Summary
`remove`	この仮想マシンをアフィニティーグループから削除します。

6.6.1. remove DELETE
リンクのコピー

この仮想マシンをアフィニティーグループから削除します。

Expand

表6.16 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.7. AffinityGroupVmLabel
リンクのコピー

このサービスは、アフィニティーグループに割り当てられた単一の仮想マシンラベルを管理します。

Expand

表6.17 メソッドの概要
名前	Summary
`remove`	アフィニティーグループからこのラベルを削除します。

6.7.1. remove DELETE
リンクのコピー

アフィニティーグループからこのラベルを削除します。

Expand

表6.18 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.8. AffinityGroupVmLabels
リンクのコピー

このサービスは、アフィニティーグループに割り当てられたすべての仮想マシンラベルのコレクションを管理します。

Expand

表6.19 メソッドの概要
名前	Summary
`add`	仮想マシンラベルをアフィニティーグループに追加します。
`list`	このアフィニティーグループに割り当てられたすべての仮想マシンラベルをリスト表示します。

6.8.1. add POST
リンクのコピー

仮想マシンラベルをアフィニティーグループに追加します。

たとえば、ラベル 789 をクラスター 123 のアフィニティーグループ 456 に追加するには、以下のような要求を送信します。

POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmlabels

POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmlabels

Copy to Clipboard

Toggle word wrap

以下のボディーを使用します。

<affinity_label id="789"/>

<affinity_label id="789"/>

Copy to Clipboard

Toggle word wrap

Expand

表6.20 パラメーターの概要
名前	型	方向	Summary
`ラベル`	AffinityLabel	In/Out	アフィニティーグループに追加する AffinityLabel オブジェクト。

6.8.2. list GET
リンクのコピー

このアフィニティーグループに割り当てられたすべての仮想マシンラベルをリスト表示します。

返されるラベルの順序は保証されません。

Expand

表6.21 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`labels`	AffinityLabel[]	Out	アフィニティーグループに割り当てられる仮想マシンのラベル。
`max`	Integer	In	返す仮想マシンラベルの最大数を設定します。

6.8.2.1. follow
リンクのコピー

6.8.2.2. max
リンクのコピー

返す仮想マシンラベルの最大数を設定します。指定されていない場合、すべてのラベルが返されます。

6.9. AffinityGroupVms
リンクのコピー

このサービスは、アフィニティーグループに割り当てられたすべての仮想マシンのコレクションを管理します。

Expand

表6.22 メソッドの概要
名前	Summary
`add`	仮想マシンをアフィニティーグループに追加します。
`list`	このアフィニティーグループに割り当てられたすべての仮想マシンをリスト表示します。

6.9.1. add POST
リンクのコピー

仮想マシンをアフィニティーグループに追加します。

たとえば、仮想マシンの 789 をクラスター 123 のアフィニティーグループ 456 に追加するには、以下のような要求を送信します。

POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms

POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms

Copy to Clipboard

Toggle word wrap

以下のボディーを使用します。

<vm id="789"/>

<vm id="789"/>

Copy to Clipboard

Toggle word wrap

Expand

表6.23 パラメーターの概要
名前	型	方向	Summary
`vm`	Vm	In/Out

6.9.2. list GET
リンクのコピー

このアフィニティーグループに割り当てられたすべての仮想マシンをリスト表示します。

返される仮想マシンの順序は保証されません。

Expand

表6.24 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す仮想マシンの最大数を設定します。
`vms`	Vm[]	Out

6.9.2.1. follow
リンクのコピー

6.9.2.2. max
リンクのコピー

返す仮想マシンの最大数を設定します。指定されていない場合には、すべての仮想マシンが返されます。

6.10. AffinityGroups
リンクのコピー

アフィニティーグループサービスは、仮想マシンの関係と依存関係を管理します。

Expand

表6.25 メソッドの概要
名前	Summary
`add`	新しいアフィニティーグループを作成します。
`list`	既存のアフィニティーグループをリスト表示します。

6.10.1. add POST
リンクのコピー

新しいアフィニティーグループを作成します。

以下の例のような Pos 要求を送信して、新しいアフィニティーグループを作成します。

POST /ovirt-engine/api/clusters/000-000/affinitygroups

POST /ovirt-engine/api/clusters/000-000/affinitygroups

Copy to Clipboard

Toggle word wrap

そして、以下の例をその本文で使用します。

<affinity_group>
  <name>AF_GROUP_001</name>
  <hosts_rule>
    <enforcing>true</enforcing>
    <positive>true</positive>
  </hosts_rule>
  <vms_rule>
    <enabled>false</enabled>
  </vms_rule>
</affinity_group>

<affinity_group>
  <name>AF_GROUP_001</name>
  <hosts_rule>
    <enforcing>true</enforcing>
    <positive>true</positive>
  </hosts_rule>
  <vms_rule>
    <enabled>false</enabled>
  </vms_rule>
</affinity_group>

Copy to Clipboard

Toggle word wrap

Expand

表6.26 パラメーターの概要
名前	型	方向	Summary
`group`	AffinityGroup	In/Out	作成するアフィニティーグループオブジェクト。

6.10.2. list GET
リンクのコピー

既存のアフィニティーグループをリスト表示します。

アフィニティーグループの結果の順序は保証されません。

Expand

表6.27 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`グループ`	AffinityGroup[]	Out	既存のアフィニティーグループのリスト。
`max`	Integer	In	返すアフィニティーグループの最大数を設定します。

6.10.2.1. follow
リンクのコピー

6.10.2.2. max
リンクのコピー

返すアフィニティーグループの最大数を設定します。指定されていない場合は、すべてのアフィニティーグループが返されます。

6.11. AffinityLabel
リンクのコピー

単一のアフィニティーラベルの詳細。

Expand

表6.28 メソッドの概要
名前	Summary
`get`	ラベルの詳細を取得します。
`remove`	システムからラベルを削除し、削除されたラベルの割り当てを消去します。
`update`	ラベルを更新します。

6.11.1. get GET
リンクのコピー

ラベルの詳細を取得します。

Expand

表6.29 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`ラベル`	AffinityLabel	Out

6.11.1.1. follow
リンクのコピー

6.11.2. remove DELETE
リンクのコピー

システムからラベルを削除し、削除されたラベルの割り当てを消去します。

6.11.3. update PUT
リンクのコピー

ラベルを更新します。この呼び出しは、名前や説明などのメタデータをすべて更新します。

Expand

表6.30 パラメーターの概要
名前	型	方向	Summary
`ラベル`	AffinityLabel	In/Out

6.12. AffinityLabelHost
リンクのコピー

このサービスは、affinitylabels/hosts サブコレクションでアクセスする際に特定のラベルを持つホストを表します。

Expand

表6.31 メソッドの概要
名前	Summary
`get`	このラベルが割り当てられたホストの詳細を取得します。
`remove`	ホストからラベルを削除します。

6.12.1. get GET
リンクのコピー

このラベルが割り当てられたホストの詳細を取得します。

Expand

表6.32 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`host`	ホスト	Out

6.12.1.1. follow
リンクのコピー

6.12.2. remove DELETE
リンクのコピー

ホストからラベルを削除します。

6.13. AffinityLabelHosts
リンクのコピー

このサービスは、affinitylabels/hosts サブコレクションでアクセスする際に特定のラベルを持つホストのリストを表します。

Expand

表6.33 メソッドの概要
名前	Summary
`add`	Add a label to a host.
`list`	ラベルの付いたホストをすべてリスト表示します。

6.13.1. add POST
リンクのコピー

Add a label to a host.

Expand

表6.34 パラメーターの概要
名前	型	方向	Summary
`host`	ホスト	In/Out

6.13.2. list GET
リンクのコピー

ラベルの付いたホストをすべてリスト表示します。

返されるホストの順序は保証されません。

Expand

表6.35 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hosts`	Host[]	Out

6.13.2.1. follow
リンクのコピー

6.14. AffinityLabelVm
リンクのコピー

このサービスは、affinitylabels/vms サブコレクションでアクセスする際に特定のラベルを持つ仮想マシンを表します。

Expand

表6.36 メソッドの概要
名前	Summary
`get`	このラベルが割り当てられた仮想マシンの詳細を取得します。
`remove`	仮想マシンからラベルを削除します。

6.14.1. get GET
リンクのコピー

このラベルが割り当てられた仮想マシンの詳細を取得します。

Expand

表6.37 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`vm`	Vm	Out

6.14.1.1. follow
リンクのコピー

6.14.2. remove DELETE
リンクのコピー

仮想マシンからラベルを削除します。

6.15. AffinityLabelVms
リンクのコピー

このサービスは、affinitylabels/vms サブコレクションでアクセスする際に特定のラベルを持つ仮想マシンのリストを表します。

Expand

表6.38 メソッドの概要
名前	Summary
`add`	仮想マシンにラベルを追加します。
`list`	ラベルの付いた仮想マシンのリストを表示します。

6.15.1. add POST
リンクのコピー

仮想マシンにラベルを追加します。

Expand

表6.39 パラメーターの概要
名前	型	方向	Summary
`vm`	Vm	In/Out

6.15.2. list GET
リンクのコピー

ラベルの付いた仮想マシンのリストを表示します。

返される仮想マシンの順序は保証されません。

Expand

表6.40 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`vms`	Vm[]	Out

6.15.2.1. follow
リンクのコピー

6.16. AffinityLabels
リンクのコピー

システムで利用可能なアフィニティーラベルを管理します。

Expand

表6.41 メソッドの概要
名前	Summary
`add`	新しいラベルを作成します。
`list`	システムに存在するすべてのラベルをリスト表示します。

6.16.1. add POST
リンクのコピー

新しいラベルを作成します。ラベルは、vms または hosts リストにあるすべてのエンティティーに自動的に割り当てられます。

Expand

表6.42 パラメーターの概要
名前	型	方向	Summary
`ラベル`	AffinityLabel	In/Out

6.16.2. list GET
リンクのコピー

システムに存在するすべてのラベルをリスト表示します。

返されるラベルの順序は保証されません。

Expand

表6.43 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`labels`	AffinityLabel[]	Out
`max`	Integer	In	返すラベルの最大数を設定します。

6.16.2.1. follow
リンクのコピー

6.16.2.2. max
リンクのコピー

返すラベルの最大数を設定します。指定されていない場合、すべてのラベルが返されます。

6.17. エリア
リンクのコピー

このアノテーションは、どの oVirt エリアがアノテーション付きの概念に関連しているかを指定することが目的です。現在、以下のエリアが使用されており、oVirt チームと密接に関連していますが、必ずしも同じではありません。

Infrastructure
Network
SLA
ストレージ
仮想化

概念は、複数の領域に関連付けるか、領域なしに割り当てることができます。

このアノテーションの値は、レポートのみを目的としており、生成されたすべてのコードやモデルの有効性には影響しません。

6.18. AssignedAffinityLabel
リンクのコピー

このサービスは、entities/affinitylabels サブコレクションを使用してアクセスすると、エンティティー割り当てに対する 1 つのラベルを表します。

Expand

表6.44 メソッドの概要
名前	Summary
`get`	割り当てられたラベルの詳細を取得します。
`remove`	エンティティーからラベルを削除します。

6.18.1. get GET
リンクのコピー

割り当てられたラベルの詳細を取得します。

Expand

表6.45 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`ラベル`	AffinityLabel	Out

6.18.1.1. follow
リンクのコピー

6.18.2. remove DELETE
リンクのコピー

エンティティーからラベルを削除します。ラベル自体には触れません。

6.19. AssignedAffinityLabels
リンクのコピー

このサービスは、entities/affinitylabels を使用してアクセスする際にサポートされているエンティティーに割り当てられるアフィニティーラベルをリスト表示し、操作するために使用されます。

Expand

表6.46 メソッドの概要
名前	Summary
`add`	ラベルをエンティティーに割り当てます。
`list`	エンティティーに割り当てられたすべてのラベルをリスト表示します。

6.19.1. add POST
リンクのコピー

ラベルをエンティティーに割り当てます。

Expand

表6.47 パラメーターの概要
名前	型	方向	Summary
`ラベル`	AffinityLabel	In/Out

6.19.2. list GET
リンクのコピー

エンティティーに割り当てられたすべてのラベルをリスト表示します。

返されるエンティティーの順序は保証されません。

Expand

表6.48 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`ラベル`	AffinityLabel[]	Out

6.19.2.1. follow
リンクのコピー

6.20. AssignedCpuProfile
リンクのコピー

Expand

表6.49 メソッドの概要
名前	Summary
`get`
`remove`

6.20.1. get GET
リンクのコピー

Expand

表6.50 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`profile`	CpuProfile	Out

6.20.1.1. follow
リンクのコピー

6.20.2. remove DELETE
リンクのコピー

Expand

表6.51 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.21. AssignedCpuProfiles
リンクのコピー

Expand

表6.52 メソッドの概要
名前	Summary
`add`	クラスターの新しい cpu プロファイルを追加します。
`list`	クラスターに割り当てられた CPU プロファイルをリスト表示します。

6.21.1. add POST
リンクのコピー

クラスターの新しい cpu プロファイルを追加します。

Expand

表6.53 パラメーターの概要
名前	型	方向	Summary
`profile`	CpuProfile	In/Out

6.21.2. list GET
リンクのコピー

クラスターに割り当てられた CPU プロファイルをリスト表示します。

返される CPU プロファイルの順序は保証されません。

Expand

表6.54 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロファイルの最大数を設定します。
`profiles`	CpuProfile[]	Out

6.21.2.1. follow
リンクのコピー

6.21.2.2. max
リンクのコピー

返すプロファイルの最大数を設定します。指定されていない場合は、すべてのプロファイルが返されます。

6.22. AssignedDiskProfile
リンクのコピー

Expand

表6.55 メソッドの概要
名前	Summary
`get`
`remove`

6.22.1. get GET
リンクのコピー

Expand

表6.56 パラメーターの概要
名前	型	方向	Summary
`disk_profile`	DiskProfile	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.22.1.1. follow
リンクのコピー

6.22.2. remove DELETE
リンクのコピー

Expand

表6.57 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.23. AssignedDiskProfiles
リンクのコピー

Expand

表6.58 メソッドの概要
名前	Summary
`add`	ストレージドメインの新規ディスクプロファイルを追加します。
`list`	ストレージドメインに割り当てられたディスクプロファイルのリストを返します。

6.23.1. add POST
リンクのコピー

ストレージドメインの新規ディスクプロファイルを追加します。

Expand

表6.59 パラメーターの概要
名前	型	方向	Summary
`profile`	DiskProfile	In/Out

6.23.2. list GET
リンクのコピー

ストレージドメインに割り当てられたディスクプロファイルのリストを返します。

返されるディスクプロファイルの順序は保証されません。

Expand

表6.60 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロファイルの最大数を設定します。
`profiles`	DiskProfile[]	Out

6.23.2.1. follow
リンクのコピー

6.23.2.2. max
リンクのコピー

返すプロファイルの最大数を設定します。指定されていない場合は、すべてのプロファイルが返されます。

6.24. AssignedPermissions
リンクのコピー

ユーザー、グループ、またはエンティティータイプ別にスコープ指定されたパーミッションサブコレクションを表します。

Expand

表6.61 メソッドの概要
名前	Summary
`add`	特定のエンティティーのユーザーまたはグループに新しいパーミッションを割り当てます。
`list`	特定のエンティティーのすべてのパーミッションをリスト表示します。

6.24.1. add POST
リンクのコピー

特定のエンティティーのユーザーまたはグループに新しいパーミッションを割り当てます。

たとえば、UserVmManager ロールを ID が 123 の仮想マシン、id が 456 のユーザーに割り当てるには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/permissions

POST /ovirt-engine/api/vms/123/permissions

Copy to Clipboard

Toggle word wrap

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

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>

Copy to Clipboard

Toggle word wrap

id が 456 のユーザーに SuperUser ロールを割り当てるには、以下のように要求を送信します。

POST /ovirt-engine/api/permissions

POST /ovirt-engine/api/permissions

Copy to Clipboard

Toggle word wrap

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

<permission>
  <role>
    <name>SuperUser</name>
  </role>
  <user id="456"/>
</permission>

<permission>
  <role>
    <name>SuperUser</name>
  </role>
  <user id="456"/>
</permission>

Copy to Clipboard

Toggle word wrap

ユーザーの代わりにグループにパーミッションを割り当てる場合は、user 要素を group の適切な ID に置き換えます。たとえば、UserRole ロールを ID が 123 のクラスター、ID が 789 のグループに割り当てるには、以下のような要求を送信します。

POST /ovirt-engine/api/clusters/123/permissions

POST /ovirt-engine/api/clusters/123/permissions

Copy to Clipboard

Toggle word wrap

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

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>

Copy to Clipboard

Toggle word wrap

Expand

表6.62 パラメーターの概要
名前	型	方向	Summary
`permission`	Permission	In/Out	パーミッション。

6.24.2. list GET
リンクのコピー

特定のエンティティーのすべてのパーミッションをリスト表示します。

たとえば、id 123 のクラスターのすべての権限をリスト表示するには、以下のように要求を送信します。

GET /ovirt-engine/api/clusters/123/permissions

GET /ovirt-engine/api/clusters/123/permissions

Copy to Clipboard

Toggle word wrap

<permissions>
  <permission id="456">
    <cluster id="123"/>
    <role id="789"/>
    <user id="451"/>
  </permission>
  <permission id="654">
    <cluster id="123"/>
    <role id="789"/>
    <group id="127"/>
  </permission>
</permissions>

<permissions>
  <permission id="456">
    <cluster id="123"/>
    <role id="789"/>
    <user id="451"/>
  </permission>
  <permission id="654">
    <cluster id="123"/>
    <role id="789"/>
    <group id="127"/>
  </permission>
</permissions>

Copy to Clipboard

Toggle word wrap

返されるパーミッションの順序は保証されません。

Expand

表6.63 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`permissions`	Permission[]	Out	パーミッションのリスト

6.24.2.1. follow
リンクのコピー

6.25. AssignedRoles
リンクのコピー

ロールサブコレクション (例: ユーザーごとにスコープ設定) を表します。

Expand

表6.64 メソッドの概要
名前	Summary
`list`	パーミッションに割り当てられたロールを返します。

6.25.1. list GET
リンクのコピー

パーミッションに割り当てられたロールを返します。

返されるロールの順序は保証されません。

Expand

表6.65 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すロールの最大数を設定します。
`roles`	Role[]	Out

6.25.1.1. follow
リンクのコピー

6.25.1.2. max
リンクのコピー

返すロールの最大数を設定します。指定のない場合は、すべてのロールが返されます。

6.26. AssignedTag
リンクのコピー

システムの特定エンティティーへの特定のタグの割り当てを管理するサービス

Expand

表6.66 メソッドの概要
名前	Summary
`get`	割り当てられたタグに関する情報を取得します。
`remove`	システムの特定のエンティティーからタグの割り当てを解除します。

6.26.1. get GET
リンクのコピー

割り当てられたタグに関する情報を取得します。

たとえば、id 123 の仮想マシンに割り当てられる id 456 のタグに関する情報を取得するには、以下のように要求を送信します。

GET /ovirt-engine/api/vms/123/tags/456

GET /ovirt-engine/api/vms/123/tags/456

Copy to Clipboard

Toggle word wrap

<tag href="/ovirt-engine/api/tags/456" id="456">
  <name>root</name>
  <description>root</description>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</tag>

<tag href="/ovirt-engine/api/tags/456" id="456">
  <name>root</name>
  <description>root</description>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</tag>

Copy to Clipboard

Toggle word wrap

Expand

表6.67 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`tag`	タグ	Out	割り当てられたタグ。

6.26.1.1. follow
リンクのコピー

6.26.2. remove DELETE
リンクのコピー

システムの特定のエンティティーからタグの割り当てを解除します。

たとえば、id 123 の仮想マシンから id 456 のタグの割り当てを解除するには、以下のように要求を送信します。

DELETE /ovirt-engine/api/vms/123/tags/456

DELETE /ovirt-engine/api/vms/123/tags/456

Copy to Clipboard

Toggle word wrap

Expand

表6.68 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.27. AssignedTags
リンクのコピー

システムの特定のエンティティーへのタグの割り当てを管理するサービス。

Expand

表6.69 メソッドの概要
名前	Summary
`add`	システムの特定のエンティティーにタグを割り当てます。
`list`	特定のエンティティーに割り当てられたすべてのタグをリスト表示します。

6.27.1. add POST
リンクのコピー

システムの特定のエンティティーにタグを割り当てます。

たとえば、ID が 123 の仮想マシンにタグ mytag を割り当てるには、次のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/tags

POST /ovirt-engine/api/vms/123/tags

Copy to Clipboard

Toggle word wrap

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

<tag>
  <name>mytag</name>
</tag>

<tag>
  <name>mytag</name>
</tag>

Copy to Clipboard

Toggle word wrap

Expand

表6.70 パラメーターの概要
名前	型	方向	Summary
`tag`	タグ	In/Out	割り当てられたタグ。

6.27.2. list GET
リンクのコピー

特定のエンティティーに割り当てられたすべてのタグをリスト表示します。

たとえば、id 123 の仮想マシンのタグのリストを表示するには、以下のようにリクエストを送信します。

GET /ovirt-engine/api/vms/123/tags

GET /ovirt-engine/api/vms/123/tags

Copy to Clipboard

Toggle word wrap

<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>mytag</name>
    <description>mytag</description>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </tag>
</tags>

<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>mytag</name>
    <description>mytag</description>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </tag>
</tags>

Copy to Clipboard

Toggle word wrap

返されるタグの順序は保証されません。

Expand

表6.71 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すタグの最大数を設定します。
`tags`	Tag[]	Out	割り当てられたタグのリスト。

6.27.2.1. follow
リンクのコピー

6.27.2.2. max
リンクのコピー

返すタグの最大数を設定します。指定されていない場合は、すべてのタグが返されます。

6.28. AssignedVnicProfile
リンクのコピー

Expand

表6.72 メソッドの概要
名前	Summary
`get`
`remove`

6.28.1. get GET
リンクのコピー

Expand

表6.73 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`profile`	VnicProfile	Out

6.28.1.1. follow
リンクのコピー

6.28.2. remove DELETE
リンクのコピー

Expand

表6.74 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.29. AssignedVnicProfiles
リンクのコピー

Expand

表6.75 メソッドの概要
名前	Summary
`add`	ネットワーク用の新しい仮想ネットワークインターフェイスカードプロファイルを追加します。
`list`	ネットワークに割り当てられる VNIC プロファイルのリストを返します。

6.29.1. add POST
リンクのコピー

ネットワーク用の新しい仮想ネットワークインターフェイスカードプロファイルを追加します。

Expand

表6.76 パラメーターの概要
名前	型	方向	Summary
`profile`	VnicProfile	In/Out

6.29.2. list GET
リンクのコピー

ネットワークに割り当てられる VNIC プロファイルのリストを返します。

返される VNIC プロファイルの順序は保証されません。

Expand

表6.77 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロファイルの最大数を設定します。
`profiles`	VnicProfile[]	Out

6.29.2.1. follow
リンクのコピー

6.29.2.2. max
リンクのコピー

返すプロファイルの最大数を設定します。指定されていない場合は、すべてのプロファイルが返されます。

6.30. AttachedStorageDomain
リンクのコピー

Expand

表6.78 メソッドの概要
名前	Summary
`activate`	この操作により、割り当てられたストレージドメインがアクティベートされます。
`deactivate`	この操作により、接続されたストレージドメインが非アクティブになります。
`get`
`remove`

6.30.1. activate POST
リンクのコピー

この操作により、割り当てられたストレージドメインがアクティベートされます。ストレージドメインがアクティブ化されると、データセンターで使用できるようになります。

POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate

POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate

Copy to Clipboard

Toggle word wrap

アクティブ化アクションはアクション固有のパラメーターを実行しないため、リクエストの本文には空の action が含まれている必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.79 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクティベーションを非同期で実行する必要があるかどうかを示します。

6.30.2. deactivate POST
リンクのコピー

この操作により、接続されたストレージドメインが非アクティブになります。ストレージドメインが非アクティブ化されると、データセンターでは使用されなくなります。たとえば、ストレージドメイン 456 を非アクティブ化するには、次のリクエストを送信します。

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate

Copy to Clipboard

Toggle word wrap

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

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

force パラメーターが true の場合、ストレージドメインの非アクティブ化が失敗する前に行われた OVF 更新が失敗した場合でも、操作は成功します。force パラメーターが false で OVF の更新に失敗すると、ストレージドメインの非アクティブ化も失敗します。

Expand

表6.80 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	非アクティブ化を非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In	ストレージドメインの OVF 更新が失敗した場合でも、操作が成功し、ストレージドメインを非アクティブ化状態に移行する必要があるかどうかを示します。

6.30.2.1. force
リンクのコピー

ストレージドメインの OVF 更新が失敗した場合でも、操作が成功し、ストレージドメインを非アクティブ化状態に移行する必要があるかどうかを示します。たとえば、force フラグを使用してストレージドメイン 456 を非アクティブ化するには、次のリクエストを送信します。

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate

Copy to Clipboard

Toggle word wrap

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

<action>
  <force>true</force>
<action>

<action>
  <force>true</force>
<action>

Copy to Clipboard

Toggle word wrap

このパラメーターはオプションであり、デフォルト値は false です。

6.30.3. get GET
リンクのコピー

Expand

表6.81 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`storage_domain`	StorageDomain	Out

6.30.3.1. follow
リンクのコピー

6.30.4. remove DELETE
リンクのコピー

Expand

表6.82 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.31. AttachedStorageDomainDisk
リンクのコピー

データセンターに接続されたストレージドメインで使用可能な単一のディスクを管理します。

重要

エンジンのバージョン 4.2 以降、このサービスは、ストレージドメインで使用可能なディスクをリスト表示し、未登録のディスクを登録することのみを目的としています。ディスクのコピー、ディスクの移動など、他のすべての操作は非推奨になり、将来削除される予定です。これらの操作を実行するには、システムのすべてのディスクを管理するサービス、または特定のディスクを管理するサービスを使用します。

Expand

表6.83 メソッドの概要
名前	Summary
`copy`	指定したストレージドメインにディスクをコピーします。
`export`	ディスクをエクスポートストレージドメインにエクスポートします。
`get`	ディスクの説明を取得します。
`move`	ディスクを別のストレージドメインに移動します。
`register`	登録解除されたディスクを登録します。
`remove`	ディスクを削除します。
`sparsify`	ディスクをスパース化します。
`update`	ディスクを更新します。

6.31.1. copy POST
リンクのコピー

指定したストレージドメインにディスクをコピーします。

重要

エンジンのバージョン 4.2 以降、この操作は非推奨になり、後方互換性のためにのみ保持されます。これは今後削除されます。ディスクをコピーするには、そのディスクを管理するサービスのコピー操作を使用します。

Expand

表6.84 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In	作成されるディスクの説明。
`storage_domain`	StorageDomain	In	新しいディスクが作成されるストレージドメイン。

6.31.2. export POST
リンクのコピー

ディスクをエクスポートストレージドメインにエクスポートします。

重要

エンジンのバージョン 4.2 以降、この操作は非推奨になり、後方互換性のためにのみ保持されます。これは今後削除されます。ディスクをエクスポートするには、そのディスクを管理するサービスのエクスポート操作を使用します。

Expand

表6.85 パラメーターの概要
名前	型	方向	Summary
`storage_domain`	StorageDomain	In	ディスクがエクスポートされるエクスポートストレージドメイン。

6.31.3. get GET
リンクのコピー

ディスクの説明を取得します。

Expand

表6.86 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	Out	ディスクの説明。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.31.3.1. follow
リンクのコピー

6.31.4. move POST
リンクのコピー

ディスクを別のストレージドメインに移動します。

重要

エンジンのバージョン 4.2 以降、この操作は非推奨になり、後方互換性のためにのみ保持されます。これは今後削除されます。ディスクを移動するには、そのディスクを管理するサービスの移動操作を使用します。

Expand

表6.87 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	移動を非同期で実行する必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`storage_domain`	StorageDomain	In	ディスクが移動されるストレージドメイン。

6.31.5. register POST
リンクのコピー

登録解除されたディスクを登録します。

6.31.6. remove DELETE
リンクのコピー

ディスクを削除します。

重要

エンジンのバージョン 4.2 以降、この操作は非推奨になり、後方互換性のためにのみ保持されます。これは今後削除されます。ディスクを削除するには、そのディスクを管理するサービスの remove 操作を使用します。

6.31.7. sparsify POST
リンクのコピー

ディスクをスパース化します。

重要

6.31.8. update PUT
リンクのコピー

ディスクを更新します。

重要

エンジンのバージョン 4.2 以降、この操作は非推奨になり、後方互換性のためにのみ保持されます。これは今後削除されます。ディスクを更新するには、そのディスクを管理するサービスの更新操作を使用します。

Expand

表6.88 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In/Out	ディスクに適用する更新。

6.32. AttachedStorageDomainDisks
リンクのコピー

データセンターに接続されているストレージドメイン内で利用可能なディスクのコレクションを管理します。

Expand

表6.89 メソッドの概要
名前	Summary
`add`	ディスクを追加または登録します。
`list`	ストレージドメインで利用可能なディスクのリストを取得します。

6.32.1. add POST
リンクのコピー

ディスクを追加または登録します。

重要

エンジンのバージョン 4.2 以降、この操作は非推奨になり、後方互換性のためにのみ保持されます。これは今後削除されます。新しいディスクを追加するには、システムのディスクを管理するサービスの add 操作を使用します。未登録のディスクを登録するには、そのディスクを管理するサービスの登録操作を使用します。

Expand

表6.90 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In/Out	追加または登録するディスク。
`unregistered`	ブール値	In	新しいディスクを追加するか、または既存の登録されていないディスクを登録する必要があるかどうかを示します。

6.32.1.1. unregistered
リンクのコピー

新しいディスクを追加するか、または既存の登録されていないディスクを登録する必要があるかどうかを示します。値が true の場合、登録するディスクの ID を指定する必要があります。たとえば、id 456 でディスクを登録するには、以下のように要求を送信します。

POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true

POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true

Copy to Clipboard

Toggle word wrap

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

<disk id="456"/>

<disk id="456"/>

Copy to Clipboard

Toggle word wrap

値が false の場合、ストレージドメインに新しいディスクが作成されます。この場合、provisioned_size 属性、format 属性、および name 属性が必須となります。たとえば、1 GiB の 書き込みディスクに新しいコピー を作成するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/storagedomains/123/disks

POST /ovirt-engine/api/storagedomains/123/disks

Copy to Clipboard

Toggle word wrap

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

<disk>
  <name>mydisk</name>
  <format>cow</format>
  <provisioned_size>1073741824</provisioned_size>
</disk>

<disk>
  <name>mydisk</name>
  <format>cow</format>
  <provisioned_size>1073741824</provisioned_size>
</disk>

Copy to Clipboard

Toggle word wrap

デフォルト値は false です。

6.32.2. list GET
リンクのコピー

ストレージドメインで利用可能なディスクのリストを取得します。

Expand

表6.91 パラメーターの概要
名前	型	方向	Summary
`disks`	Disk[]	Out	取得されたディスクのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。

6.32.2.1. disks
リンクのコピー

取得されたディスクのリスト。

返されるディスクの順序は保証されません。

6.32.2.2. follow
リンクのコピー

6.32.2.3. max
リンクのコピー

返すディスクの最大数を設定します。指定しない場合、すべてのディスクが返されます。

6.33. AttachedStorageDomains
リンクのコピー

データセンターに接続されているストレージドメインを管理します。

Expand

表6.92 メソッドの概要
名前	Summary
`add`	既存のストレージドメインをデータセンターに接続します。
`list`	データセンターにアタッチされているストレージドメインのリストを返します。

6.33.1. add POST
リンクのコピー

既存のストレージドメインをデータセンターに接続します。

Expand

表6.93 パラメーターの概要
名前	型	方向	Summary
`storage_domain`	StorageDomain	In/Out	データセンターにアタッチするストレージドメイン。

6.33.2. list GET
リンクのコピー

データセンターにアタッチされているストレージドメインのリストを返します。

返されるストレージドメインの順序は保証されません。

Expand

表6.94 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すストレージドメインの最大数を設定します。
`storage_domains`	StorageDomain[]	Out	データセンターに接続されているストレージドメインのリスト。

6.33.2.1. follow
リンクのコピー

6.33.2.2. max
リンクのコピー

返すストレージドメインの最大数を設定します。指定されていない場合は、すべてのストレージドメインが返されます。

6.34. バランス
リンクのコピー

Expand

表6.95 メソッドの概要
名前	Summary
`get`
`remove`

6.34.1. get GET
リンクのコピー

Expand

表6.96 パラメーターの概要
名前	型	方向	Summary
`balance`	バランス	Out
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.34.1.1. follow
リンクのコピー

6.34.2. remove DELETE
リンクのコピー

Expand

表6.97 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.35. バランス
リンクのコピー

Expand

表6.98 メソッドの概要
名前	Summary
`add`	指定のユーザー定義のスケジューリングポリシーにバランスモジュールを追加します。
`list`	スケジューリングポリシーで使用されるバランスモジュールのリストを返します。

6.35.1. add POST
リンクのコピー

指定のユーザー定義のスケジューリングポリシーにバランスモジュールを追加します。

Expand

表6.99 パラメーターの概要
名前	型	方向	Summary
`balance`	バランス	In/Out

6.35.2. list GET
リンクのコピー

スケジューリングポリシーで使用されるバランスモジュールのリストを返します。

返される分散モジュールの順序は保証されません。

Expand

表6.100 パラメーターの概要
名前	型	方向	Summary
`balances`	Balance[]	Out
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すバランスの最大数を設定します。

6.35.2.1. follow
リンクのコピー

6.35.2.2. max
リンクのコピー

返すバランスの最大数を設定します。指定されていない場合は、すべてのバランスが返されます。

6.36. ブックマーク
リンクのコピー

ブックマークを管理するサービス

Expand

表6.101 メソッドの概要
名前	Summary
`get`	ブックマークを取得します。
`remove`	ブックマークを削除します。
`update`	ブックマークを更新します。

6.36.1. get GET
リンクのコピー

ブックマークを取得します。

ブックマークを取得する例:

GET /ovirt-engine/api/bookmarks/123

GET /ovirt-engine/api/bookmarks/123

Copy to Clipboard

Toggle word wrap

<bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
  <name>example_vm</name>
  <value>vm: name=example*</value>
</bookmark>

<bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
  <name>example_vm</name>
  <value>vm: name=example*</value>
</bookmark>

Copy to Clipboard

Toggle word wrap

Expand

表6.102 パラメーターの概要
名前	型	方向	Summary
`bookmark`	ブックマーク	Out	要求されたブックマーク。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.36.1.1. follow
リンクのコピー

6.36.2. remove DELETE
リンクのコピー

ブックマークを削除します。

ブックマークを削除する例:

DELETE /ovirt-engine/api/bookmarks/123

DELETE /ovirt-engine/api/bookmarks/123

Copy to Clipboard

Toggle word wrap

Expand

表6.103 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.36.3. update PUT
リンクのコピー

ブックマークを更新します。

ブックマークを更新する例:

PUT /ovirt-engine/api/bookmarks/123

PUT /ovirt-engine/api/bookmarks/123

Copy to Clipboard

Toggle word wrap

リクエスト本文:

<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>

<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>

Copy to Clipboard

Toggle word wrap

Expand

表6.104 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`bookmark`	ブックマーク	In/Out	更新されたブックマーク。

6.37. ブックマーク
リンクのコピー

ブックマークを管理するサービス

Expand

表6.105 メソッドの概要
名前	Summary
`add`	新規ブックマークの追加
`list`	利用可能なブックマークをすべて表示します。

6.37.1. add POST
リンクのコピー

新規ブックマークの追加

ブックマークの追加例:

POST /ovirt-engine/api/bookmarks

POST /ovirt-engine/api/bookmarks

Copy to Clipboard

Toggle word wrap

<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>

<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>

Copy to Clipboard

Toggle word wrap

Expand

表6.106 パラメーターの概要
名前	型	方向	Summary
`bookmark`	ブックマーク	In/Out	追加されたブックマーク。

6.37.2. list GET
リンクのコピー

利用可能なブックマークをすべて表示します。

ブックマークのリスト表示例:

GET /ovirt-engine/api/bookmarks

GET /ovirt-engine/api/bookmarks

Copy to Clipboard

Toggle word wrap

<bookmarks>
  <bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
    <name>database</name>
    <value>vm: name=database*</value>
  </bookmark>
  <bookmark href="/ovirt-engine/api/bookmarks/456" id="456">
    <name>example</name>
    <value>vm: name=example*</value>
  </bookmark>
</bookmarks>

<bookmarks>
  <bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
    <name>database</name>
    <value>vm: name=database*</value>
  </bookmark>
  <bookmark href="/ovirt-engine/api/bookmarks/456" id="456">
    <name>example</name>
    <value>vm: name=example*</value>
  </bookmark>
</bookmarks>

Copy to Clipboard

Toggle word wrap

返されたブックマークの順序は保証されません。

Expand

表6.107 パラメーターの概要
名前	型	方向	Summary
`bookmarks`	Bookmark[]	Out	利用可能なブックマークのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すブックマークの最大数を設定します。

6.37.2.1. follow
リンクのコピー

6.37.2.2. max
リンクのコピー

返すブックマークの最大数を設定します。指定されていない場合は、すべてのブックマークが返されます。

6.38. クラスター
リンクのコピー

特定のクラスターを管理するサービス。

Expand

表6.108 メソッドの概要
名前	Summary
`get`	クラスターに関する情報を取得します。
`refreshglusterhealstatus`	クラスター内のすべてのボリュームの Gluster 修復情報を更新します。
`remove`	システムからクラスターを削除します。
`resetemulatedmachine`
`syncallnetworks`	クラスターのすべてのネットワークを同期します。
`update`	クラスターに関する情報を更新します。
`upgrade`	アクションの値に基づいて、クラスターのアップグレードプロセスを開始、更新、または終了します。

6.38.1. get GET
リンクのコピー

クラスターに関する情報を取得します。

クラスターを取得する例:

GET /ovirt-engine/api/clusters/123

GET /ovirt-engine/api/clusters/123

Copy to Clipboard

Toggle word wrap

<cluster href="/ovirt-engine/api/clusters/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/clusters/123/resetemulatedmachine" rel="resetemulatedmachine"/>
  </actions>
  <name>Default</name>
  <description>The default server cluster</description>
  <link href="/ovirt-engine/api/clusters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/clusters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/clusters/123/glustervolumes" rel="glustervolumes"/>
  <link href="/ovirt-engine/api/clusters/123/glusterhooks" rel="glusterhooks"/>
  <link href="/ovirt-engine/api/clusters/123/affinitygroups" rel="affinitygroups"/>
  <link href="/ovirt-engine/api/clusters/123/cpuprofiles" rel="cpuprofiles"/>
  <ballooning_enabled>false</ballooning_enabled>
  <cpu>
    <architecture>x86_64</architecture>
    <type>Intel Nehalem Family</type>
  </cpu>
  <error_handling>
    <on_error>migrate</on_error>
  </error_handling>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
  </fencing_policy>
  <gluster_service>false</gluster_service>
  <ha_reservation>false</ha_reservation>
  <ksm>
    <enabled>true</enabled>
    <merge_across_nodes>true</merge_across_nodes>
  </ksm>
  <memory_policy>
    <over_commit>
      <percent>100</percent>
    </over_commit>
    <transparent_hugepages>
      <enabled>true</enabled>
    </transparent_hugepages>
  </memory_policy>
  <migration>
    <auto_converge>inherit</auto_converge>
    <bandwidth>
      <assignment_method>auto</assignment_method>
    </bandwidth>
    <compressed>inherit</compressed>
  </migration>
  <required_rng_sources>
    <required_rng_source>random</required_rng_source>
  </required_rng_sources>
  <scheduling_policy href="/ovirt-engine/api/schedulingpolicies/456" id="456"/>
  <threads_as_cores>false</threads_as_cores>
  <trusted_service>false</trusted_service>
  <tunnel_migration>false</tunnel_migration>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  <virt_service>true</virt_service>
  <data_center href="/ovirt-engine/api/datacenters/111" id="111"/>
</cluster>

<cluster href="/ovirt-engine/api/clusters/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/clusters/123/resetemulatedmachine" rel="resetemulatedmachine"/>
  </actions>
  <name>Default</name>
  <description>The default server cluster</description>
  <link href="/ovirt-engine/api/clusters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/clusters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/clusters/123/glustervolumes" rel="glustervolumes"/>
  <link href="/ovirt-engine/api/clusters/123/glusterhooks" rel="glusterhooks"/>
  <link href="/ovirt-engine/api/clusters/123/affinitygroups" rel="affinitygroups"/>
  <link href="/ovirt-engine/api/clusters/123/cpuprofiles" rel="cpuprofiles"/>
  <ballooning_enabled>false</ballooning_enabled>
  <cpu>
    <architecture>x86_64</architecture>
    <type>Intel Nehalem Family</type>
  </cpu>
  <error_handling>
    <on_error>migrate</on_error>
  </error_handling>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
  </fencing_policy>
  <gluster_service>false</gluster_service>
  <ha_reservation>false</ha_reservation>
  <ksm>
    <enabled>true</enabled>
    <merge_across_nodes>true</merge_across_nodes>
  </ksm>
  <memory_policy>
    <over_commit>
      <percent>100</percent>
    </over_commit>
    <transparent_hugepages>
      <enabled>true</enabled>
    </transparent_hugepages>
  </memory_policy>
  <migration>
    <auto_converge>inherit</auto_converge>
    <bandwidth>
      <assignment_method>auto</assignment_method>
    </bandwidth>
    <compressed>inherit</compressed>
  </migration>
  <required_rng_sources>
    <required_rng_source>random</required_rng_source>
  </required_rng_sources>
  <scheduling_policy href="/ovirt-engine/api/schedulingpolicies/456" id="456"/>
  <threads_as_cores>false</threads_as_cores>
  <trusted_service>false</trusted_service>
  <tunnel_migration>false</tunnel_migration>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  <virt_service>true</virt_service>
  <data_center href="/ovirt-engine/api/datacenters/111" id="111"/>
</cluster>

Copy to Clipboard

Toggle word wrap

Expand

表6.109 パラメーターの概要
名前	型	方向	Summary
`cluster`	クラスター	Out
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.38.1.1. follow
リンクのコピー

6.38.2. refreshglusterhealstatus POST
リンクのコピー

クラスター内のすべてのボリュームの Gluster 修復情報を更新します。

たとえば、Cluster 123 では、以下のような要求を送信します。

POST /ovirt-engine/api/clusters/123/refreshglusterhealstatus

POST /ovirt-engine/api/clusters/123/refreshglusterhealstatus

Copy to Clipboard

Toggle word wrap

6.38.3. remove DELETE
リンクのコピー

システムからクラスターを削除します。

DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000

DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000

Copy to Clipboard

Toggle word wrap

Expand

表6.110 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.38.4. resetemulatedmachine POST
リンクのコピー

Expand

表6.111 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リセットを非同期で実行する必要があるかどうかを示します。

6.38.5. syncallnetworks POST
リンクのコピー

クラスターのすべてのネットワークを同期します。

POST /ovirt-engine/api/clusters/123/syncallnetworks

POST /ovirt-engine/api/clusters/123/syncallnetworks

Copy to Clipboard

Toggle word wrap

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

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.112 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.38.6. update PUT
リンクのコピー

クラスターに関する情報を更新します。

指定されたフィールドのみが更新されます。その他は変更されません。

たとえば、クラスターの CPU を更新するには、次のようにします。

PUT /ovirt-engine/api/clusters/123

PUT /ovirt-engine/api/clusters/123

Copy to Clipboard

Toggle word wrap

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

<cluster>
  <cpu>
    <type>Intel Haswell-noTSX Family</type>
  </cpu>
</cluster>

<cluster>
  <cpu>
    <type>Intel Haswell-noTSX Family</type>
  </cpu>
</cluster>

Copy to Clipboard

Toggle word wrap

Expand

表6.113 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`cluster`	クラスター	In/Out

6.38.7. upgrade POST
リンクのコピー

アクションの値に基づいて、クラスターのアップグレードプロセスを開始、更新、または終了します。このアクションは、start、stop、または update_progress の値をとるアクション値に基づいて、クラスターにアップグレードのマークを付けたり、進行状況を更新したり、クラスターのアップグレード実行フラグをクリアしたりします。

POST /ovirt-engine/api/clusters/123/upgrade

POST /ovirt-engine/api/clusters/123/upgrade

Copy to Clipboard

Toggle word wrap

アップグレードの対象となるクラスターをマークするための次のようなリクエスト本文を使用します。

<action>
    <upgrade_action>
        start
    </upgrade_action>
</action>

<action>
    <upgrade_action>
        start
    </upgrade_action>
</action>

Copy to Clipboard

Toggle word wrap

アップグレードを開始した後、次のようなリクエスト本文を使用して、進行状況を 15% に更新します。

<action>
    <upgrade_action>
        update_progress
    </upgrade_action>
    <upgrade_percent_complete>
        15
    </upgrade_percent_complete>
</action>

<action>
    <upgrade_action>
        update_progress
    </upgrade_action>
    <upgrade_percent_complete>
        15
    </upgrade_percent_complete>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.114 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`correlation_id`	String	In	アップグレード相関識別子を明示的に設定します。
`upgrade_action`	ClusterUpgradeAction	In	実行するアクション。
`upgrade_percent_complete`	Integer	In	アップグレードの進行状況を、プロセス全体の完了率として更新します。

6.38.7.1. correlation_id
リンクのコピー

アップグレード相関識別子を明示的に設定します。クラスターのアップグレードの詳細を示すイベントをアップグレード自体に関連付けるために使用します。指定のない場合は、Correlation-Id http ヘッダーの相関 ID が使用されます。

6.39. ClusterEnabledFeature
リンクのコピー

クラスターの有効機能を表します。

Expand

表6.115 メソッドの概要
名前	Summary
`get`	有効なクラスター機能に関する情報を提供します。
`remove`	クラスター機能を無効にします。

6.39.1. get GET
リンクのコピー

有効なクラスター機能に関する情報を提供します。

たとえば、クラスター 123 で有効な機能 456 の詳細を確認するには、以下のような要求を送信します。

GET /ovirt-engine/api/clusters/123/enabledfeatures/456

GET /ovirt-engine/api/clusters/123/enabledfeatures/456

Copy to Clipboard

Toggle word wrap

これにより、名前が含まれる ClusterFeature オブジェクトが返されます。

<cluster_feature id="456">
  <name>libgfapi_supported</name>
</cluster_feature>

<cluster_feature id="456">
  <name>libgfapi_supported</name>
</cluster_feature>

Copy to Clipboard

Toggle word wrap

Expand

表6.116 パラメーターの概要
名前	型	方向	Summary
`feature`	ClusterFeature	Out	有効なクラスター機能を取得している。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.39.1.1. follow
リンクのコピー

6.39.2. remove DELETE
リンクのコピー

クラスター機能を無効にします。

たとえば、クラスター 123 の機能 456 を無効にするには、以下のように要求を送信します。

DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456

DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456

Copy to Clipboard

Toggle word wrap

6.40. ClusterEnabledFeatures
リンクのコピー

このクラスターに対して有効にされる追加機能に関する情報を提供します。有効な機能はクラスターレベルの利用可能な機能です。

Expand

表6.117 メソッドの概要
名前	Summary
`add`	クラスターの追加機能を有効にします。
`list`	クラスターに有効な追加機能をリスト表示します。

6.40.1. add POST
リンクのコピー

クラスターの追加機能を有効にします。

たとえば、クラスター 123 で機能 456 を有効にするには、以下のような要求を送信します。

POST /ovirt-engine/api/clusters/123/enabledfeatures

POST /ovirt-engine/api/clusters/123/enabledfeatures

Copy to Clipboard

Toggle word wrap

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

<cluster_feature id="456"/>

<cluster_feature id="456"/>

Copy to Clipboard

Toggle word wrap

Expand

表6.118 パラメーターの概要
名前	型	方向	Summary
`feature`	ClusterFeature	In/Out

6.40.2. list GET
リンクのコピー

クラスターに有効な追加機能をリスト表示します。

たとえば、クラスター 123 の機能を有効にするには、以下のような要求を送信します。

GET /ovirt-engine/api/clusters/123/enabledfeatures

GET /ovirt-engine/api/clusters/123/enabledfeatures

Copy to Clipboard

Toggle word wrap

これにより、機能のリストが返されます。

<enabled_features>
  <cluster_feature id="123">
     <name>test_feature</name>
  </cluster_feature>
  ...
</enabled_features>

<enabled_features>
  <cluster_feature id="123">
     <name>test_feature</name>
  </cluster_feature>
  ...
</enabled_features>

Copy to Clipboard

Toggle word wrap

Expand

表6.119 パラメーターの概要
名前	型	方向	Summary
`features`	ClusterFeature[]	Out	取得される機能。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.40.2.1. follow
リンクのコピー

6.41. ClusterExternalProviders
リンクのコピー

このサービスは、外部プロバイダーをリスト表示します。

Expand

表6.120 メソッドの概要
名前	Summary
`list`	外部プロバイダーリストを返します。

6.41.1. list GET
リンクのコピー

外部プロバイダーリストを返します。

返されたプロバイダーリストの順序は保証されません。

Expand

表6.121 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`providers`	ExternalProvider[]	Out

6.41.1.1. follow
リンクのコピー

6.42. ClusterFeature
リンクのコピー

クラスターレベルで有効になっている機能を表します。

Expand

表6.122 メソッドの概要
名前	Summary
`get`	クラスターレベルでサポートされるクラスター機能に関する情報を提供します。

6.42.1. get GET
リンクのコピー

クラスターレベルでサポートされるクラスター機能に関する情報を提供します。

たとえば、クラスターレベル 4.1 のクラスター機能 456 の詳細は、以下のような要求を送信します。

GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456

GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456

Copy to Clipboard

Toggle word wrap

これにより、名前が含まれる ClusterFeature オブジェクトが返されます。

<cluster_feature id="456">
  <name>libgfapi_supported</name>
</cluster_feature>

<cluster_feature id="456">
  <name>libgfapi_supported</name>
</cluster_feature>

Copy to Clipboard

Toggle word wrap

Expand

表6.123 パラメーターの概要
名前	型	方向	Summary
`feature`	ClusterFeature	Out	取得されるクラスター機能。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.42.1.1. follow
リンクのコピー

6.43. ClusterFeatures
リンクのコピー

クラスターレベルでサポートされるクラスター機能に関する情報を提供します。

Expand

表6.124 メソッドの概要
名前	Summary
`list`	クラスターレベルでサポートされるクラスター機能をリスト表示します。

6.43.1. list GET
リンクのコピー

クラスターレベルでサポートされるクラスター機能をリスト表示します。

GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures

GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures

Copy to Clipboard

Toggle word wrap

これにより、クラスターレベルでサポートされるクラスター機能のリストが返されます。

<cluster_features>
  <cluster_feature id="123">
     <name>test_feature</name>
  </cluster_feature>
  ...
</cluster_features>

<cluster_features>
  <cluster_feature id="123">
     <name>test_feature</name>
  </cluster_feature>
  ...
</cluster_features>

Copy to Clipboard

Toggle word wrap

Expand

表6.125 パラメーターの概要
名前	型	方向	Summary
`features`	ClusterFeature[]	Out	取得される機能。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.43.1.1. follow
リンクのコピー

6.44. ClusterLevel
リンクのコピー

特定のクラスターレベルに関する情報を提供します。詳細は、ClusterLevels サービスを参照してください。

Expand

表6.126 メソッドの概要
名前	Summary
`get`	このサービスが管理する特定のクラスターレベルの機能に関する情報を提供します。

6.44.1. get GET
リンクのコピー

このサービスが管理する特定のクラスターレベルの機能に関する情報を提供します。

たとえば、レベル 3.6 でサポートされる CPU タイプを確認するには、以下のように要求を送信できます。

GET /ovirt-engine/api/clusterlevels/3.6

GET /ovirt-engine/api/clusterlevels/3.6

Copy to Clipboard

Toggle word wrap

これにより、サポートされる CPU タイプとクラスターレベルを記述する他の情報が含まれる ClusterLevel オブジェクトが返されます。

<cluster_level id="3.6">
  <cpu_types>
    <cpu_type>
      <name>Intel Nehalem Family</name>
      <level>3</level>
      <architecture>x86_64</architecture>
    </cpu_type>
    ...
  </cpu_types>
  <permits>
    <permit id="1">
      <name>create_vm</name>
      <administrative>false</administrative>
    </permit>
    ...
  </permits>
</cluster_level>

<cluster_level id="3.6">
  <cpu_types>
    <cpu_type>
      <name>Intel Nehalem Family</name>
      <level>3</level>
      <architecture>x86_64</architecture>
    </cpu_type>
    ...
  </cpu_types>
  <permits>
    <permit id="1">
      <name>create_vm</name>
      <administrative>false</administrative>
    </permit>
    ...
  </permits>
</cluster_level>

Copy to Clipboard

Toggle word wrap

Expand

表6.127 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`level`	ClusterLevel	Out	取得したクラスターレベル。

6.44.1.1. follow
リンクのコピー

6.45. ClusterLevels
リンクのコピー

エンジンがサポートするさまざまなクラスターレベルの機能に関する情報を提供します。エンジンのバージョン 4.0 は、レベル 4.0 および 3.6 をサポートします。これらのレベルのそれぞれは、さまざまな CPU タイプのセットをサポートします。以下に例を示します。このサービスは、その情報を提供します。

Expand

表6.128 メソッドの概要
名前	Summary
`list`	システムがサポートするクラスターレベルをリスト表示します。

6.45.1. list GET
リンクのコピー

システムがサポートするクラスターレベルをリスト表示します。

GET /ovirt-engine/api/clusterlevels

GET /ovirt-engine/api/clusterlevels

Copy to Clipboard

Toggle word wrap

これにより、利用可能なクラスターレベルのリストが返されます。

<cluster_levels>
  <cluster_level id="4.0">
     ...
  </cluster_level>
  ...
</cluster_levels>

<cluster_levels>
  <cluster_level id="4.0">
     ...
  </cluster_level>
  ...
</cluster_levels>

Copy to Clipboard

Toggle word wrap

返されるクラスターレベルの順序は保証されません。

Expand

表6.129 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`levels`	ClusterLevel[]	Out	取得されるクラスターレベル。

6.45.1.1. follow
リンクのコピー

6.46. ClusterNetwork
リンクのコピー

特定のクラスターネットワークを管理するサービス

Expand

表6.130 メソッドの概要
名前	Summary
`get`	クラスターネットワークの詳細を取得します。
`remove`	クラスターからネットワークの割り当てを解除します。
`update`	クラスターのネットワークを更新します。

6.46.1. get GET
リンクのコピー

クラスターネットワークの詳細を取得します。

Expand

表6.131 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`network`	Network	Out	クラスターネットワーク

6.46.1.1. follow
リンクのコピー

6.46.2. remove DELETE
リンクのコピー

クラスターからネットワークの割り当てを解除します。

6.46.3. update PUT
リンクのコピー

クラスターのネットワークを更新します。

Expand

表6.132 パラメーターの概要
名前	型	方向	Summary
`network`	Network	In/Out	クラスターネットワーク

6.47. ClusterNetworks
リンクのコピー

クラスターネットワークを管理するサービス

Expand

表6.133 メソッドの概要
名前	Summary
`add`	ネットワークをクラスターに割り当てます。
`list`	クラスターに割り当てられているネットワークをリスト表示します。

6.47.1. add POST
リンクのコピー

ネットワークをクラスターに割り当てます。

以下の例のような Post 要求を送信して、ネットワークをクラスターに割り当てます。

POST /ovirt-engine/api/clusters/123/networks

POST /ovirt-engine/api/clusters/123/networks

Copy to Clipboard

Toggle word wrap

ボディーで以下の例を使用します。

<network id="123" />

<network id="123" />

Copy to Clipboard

Toggle word wrap

Expand

表6.134 パラメーターの概要
名前	型	方向	Summary
`network`	Network	In/Out	クラスターに割り当てるネットワークオブジェクト。

6.47.2. list GET
リンクのコピー

クラスターに割り当てられているネットワークをリスト表示します。

返されるクラスターの順序は保証されません。

Expand

表6.135 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すネットワークの最大数を設定します。
`networks`	Network[]	Out	クラスターに割り当てられているネットワークのリスト。

6.47.2.1. follow
リンクのコピー

6.47.2.2. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

6.48. Clusters
リンクのコピー

クラスターを管理するサービス

Expand

表6.136 メソッドの概要
名前	Summary
`add`	新規クラスターを作成します。
`list`	システムのクラスターリストを返します。

6.48.1. add POST
リンクのコピー

新規クラスターを作成します。

これには、name、cpu.type、および data_center 属性が必要です。id または name 属性のいずれかでデータセンターを特定します。

POST /ovirt-engine/api/clusters

POST /ovirt-engine/api/clusters

Copy to Clipboard

Toggle word wrap

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

<cluster>
  <name>mycluster</name>
  <cpu>
    <type>Intel Nehalem Family</type>
  </cpu>
  <data_center id="123"/>
</cluster>

<cluster>
  <name>mycluster</name>
  <cpu>
    <type>Intel Nehalem Family</type>
  </cpu>
  <data_center id="123"/>
</cluster>

Copy to Clipboard

Toggle word wrap

クラスターに追加されるすべてのホストにデプロイされる外部ネットワークプロバイダーでクラスターを作成するには、以下のような要求を送信します。

POST /ovirt-engine/api/clusters

POST /ovirt-engine/api/clusters

Copy to Clipboard

Toggle word wrap

必要なプロバイダーへの参照が含まれるリクエスト本文:

<cluster>
  <name>mycluster</name>
  <cpu>
    <type>Intel Nehalem Family</type>
  </cpu>
  <data_center id="123"/>
  <external_network_providers>
    <external_provider name="ovirt-provider-ovn"/>
  </external_network_providers>
</cluster>

<cluster>
  <name>mycluster</name>
  <cpu>
    <type>Intel Nehalem Family</type>
  </cpu>
  <data_center id="123"/>
  <external_network_providers>
    <external_provider name="ovirt-provider-ovn"/>
  </external_network_providers>
</cluster>

Copy to Clipboard

Toggle word wrap

Expand

表6.137 パラメーターの概要
名前	型	方向	Summary
`cluster`	クラスター	In/Out

6.48.2. list GET
リンクのコピー

システムのクラスターリストを返します。

sortby 句が search パラメーターに含まれている場合にのみ、返されるクラスターの順序は保証されます。

Expand

表6.138 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	検索時に大文字と小文字の区別が考慮されるかどうかを示します。
`clusters`	Cluster[]	Out
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すことのできるクラスターの最大数。
`search`	String	In	返されたクラスターを制限するために使用されるクエリー文字列。

6.48.2.1. case_sensitive
リンクのコピー

検索時に大文字と小文字の区別が考慮されるかどうかを示します。デフォルト値は true です。つまり、大文字と小文字の区別が考慮されます。無視するケースを検索するには、false に設定します。

6.48.2.2. follow
リンクのコピー

6.48.2.3. max
リンクのコピー

返すことのできるクラスターの最大数。指定されていない場合、すべてのクラスターが返されます。

6.49. コピー可能
リンクのコピー

Expand

表6.139 メソッドの概要
名前	Summary
`copy`

6.49.1. copy POST
リンクのコピー

Expand

表6.140 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	コピーを非同期的に実行するかどうかを指定します。

6.50. CpuProfile
リンクのコピー

Expand

表6.141 メソッドの概要
名前	Summary
`get`
`remove`
`update`	システムで指定した cpu プロファイルを更新します。

6.50.1. get GET
リンクのコピー

Expand

表6.142 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`profile`	CpuProfile	Out

6.50.1.1. follow
リンクのコピー

6.50.2. remove DELETE
リンクのコピー

Expand

表6.143 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.50.3. update PUT
リンクのコピー

システムで指定した cpu プロファイルを更新します。

Expand

表6.144 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`profile`	CpuProfile	In/Out

6.51. CpuProfiles
リンクのコピー

Expand

表6.145 メソッドの概要
名前	Summary
`add`	システムに新しい cpu プロファイルを追加します。
`list`	システムの CPU プロファイルリストを返します。

6.51.1. add POST
リンクのコピー

システムに新しい cpu プロファイルを追加します。

Expand

表6.146 パラメーターの概要
名前	型	方向	Summary
`profile`	CpuProfile	In/Out

6.51.2. list GET
リンクのコピー

システムの CPU プロファイルリストを返します。

返される CPU プロファイルのリストの順序はランダムです。

Expand

表6.147 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロファイルの最大数を設定します。
`profile`	CpuProfile[]	Out

6.51.2.1. follow
リンクのコピー

6.51.2.2. max
リンクのコピー

返すプロファイルの最大数を設定します。指定されていない場合は、すべてのプロファイルが返されます。

6.52. DataCenter
リンクのコピー

データセンターを管理するサービス

Expand

表6.148 メソッドの概要
名前	Summary
`cleanfinishedtasks`	現在、SPM に未クリアのタスクがある場合、Storage Pool Manager (SPM) は別のホストへの切り替えに失敗します。
`get`	データセンターを取得します。
`remove`	データセンターを削除します。
`setmaster`	データセンター内のストレージドメインをマスターとして手動で設定する際に使用します。
`update`	データセンターを更新します。

6.52.1. cleanfinishedtasks POST
リンクのコピー

現在、SPM に未クリアのタスクがある場合、Storage Pool Manager (SPM) は別のホストへの切り替えに失敗します。終了したすべてのタスクを消去すると SPM スイッチが有効になります。

たとえば、ID 123 のデータセンターで終了したタスクをすべてクリーニングするには、以下のように要求を送信します。

POST /ovirt-engine/api/datacenters/123/cleanfinishedtasks

POST /ovirt-engine/api/datacenters/123/cleanfinishedtasks

Copy to Clipboard

Toggle word wrap

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

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.149 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.52.2. get GET
リンクのコピー

データセンターを取得します。

データセンターを取得する例:

GET /ovirt-engine/api/datacenters/123

GET /ovirt-engine/api/datacenters/123

Copy to Clipboard

Toggle word wrap

<data_center href="/ovirt-engine/api/datacenters/123" id="123">
  <name>Default</name>
  <description>The default Data Center</description>
  <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
  <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
  <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
  <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
  <local>false</local>
  <quota_mode>disabled</quota_mode>
  <status>up</status>
  <storage_format>v3</storage_format>
  <supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
   </version>
  </supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  <mac_pool href="/ovirt-engine/api/macpools/456" id="456"/>
</data_center>

<data_center href="/ovirt-engine/api/datacenters/123" id="123">
  <name>Default</name>
  <description>The default Data Center</description>
  <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
  <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
  <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
  <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
  <local>false</local>
  <quota_mode>disabled</quota_mode>
  <status>up</status>
  <storage_format>v3</storage_format>
  <supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
   </version>
  </supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  <mac_pool href="/ovirt-engine/api/macpools/456" id="456"/>
</data_center>

Copy to Clipboard

Toggle word wrap

Expand

表6.150 パラメーターの概要
名前	型	方向	Summary
`data_center`	DataCenter	Out
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.52.2.1. follow
リンクのコピー

6.52.3. remove DELETE
リンクのコピー

データセンターを削除します。

DELETE /ovirt-engine/api/datacenters/123

DELETE /ovirt-engine/api/datacenters/123

Copy to Clipboard

Toggle word wrap

特別なパラメーターがないと、データセンターにアタッチされたストレージドメインは切り離され、ストレージから削除されます。この操作の実行中に何かが失敗した場合、たとえば、ストレージからストレージドメインを削除するために使用できるホストがない場合、操作全体が失敗します。

force パラメーターが true の場合、たとえば 1 つのストレージドメインの削除中に何かが失敗した場合でも、操作は常に成功します。障害は無視され、データセンターがデータベースから削除されます。

Expand

表6.151 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。
`force`	ブール値	In	操作中に何かが失敗した場合でも、操作が成功し、ストレージドメインがデータベースから削除されるかどうかを示します。

6.52.3.1. force
リンクのコピー

操作中に何かが失敗した場合でも、操作が成功し、ストレージドメインがデータベースから削除されるかどうかを示します。

このパラメーターはオプションであり、デフォルト値は false です。

6.52.4. setmaster POST
リンクのコピー

データセンター内のストレージドメインをマスターとして手動で設定する際に使用します。たとえば、ID '456' のストレージドメインを ID'123' のデータセンターのマスターとして設定するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/datacenters/123/setmaster

POST /ovirt-engine/api/datacenters/123/setmaster

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain id="456"/>
</action>

<action>
  <storage_domain id="456"/>
</action>

Copy to Clipboard

Toggle word wrap

新規マスターストレージドメインは名前で指定することもできます。

Expand

表6.152 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`storage_domain`	StorageDomain	In	データセンターの新規マスターストレージドメイン。

6.52.5. update PUT
リンクのコピー

データセンターを更新します。

name、description、storage_type、version、storage_format、および mac_pool 要素は、作成後に更新可能です。たとえば、データセンター 123 の名前と説明を変更するには、以下のようにリクエストを送信します。

PUT /ovirt-engine/api/datacenters/123

PUT /ovirt-engine/api/datacenters/123

Copy to Clipboard

Toggle word wrap

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

<data_center>
  <name>myupdatedname</name>
  <description>An updated description for the data center</description>
</data_center>

<data_center>
  <name>myupdatedname</name>
  <description>An updated description for the data center</description>
</data_center>

Copy to Clipboard

Toggle word wrap

Expand

表6.153 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`data_center`	DataCenter	In/Out	更新されたデータセンター。

6.53. DataCenterNetwork
リンクのコピー

特定のデータセンターネットワークを管理するサービス

Expand

表6.154 メソッドの概要
名前	Summary
`get`	データセンターネットワークの詳細を取得します。
`remove`	ネットワークを削除します。
`update`	データセンター内のネットワークを更新します。

6.53.1. get GET
リンクのコピー

データセンターネットワークの詳細を取得します。

Expand

表6.155 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`network`	Network	Out	データセンターネットワーク。

6.53.1.1. follow
リンクのコピー

6.53.2. remove DELETE
リンクのコピー

ネットワークを削除します。

6.53.3. update PUT
リンクのコピー

データセンター内のネットワークを更新します。

Expand

表6.156 パラメーターの概要
名前	型	方向	Summary
`network`	Network	In/Out	データセンターネットワーク。

6.54. DataCenterNetworks
リンクのコピー

データセンターネットワークを管理するサービス

Expand

表6.157 メソッドの概要
名前	Summary
`add`	データセンターに新しいネットワークを作成します。
`list`	データセンター内のネットワークをリスト表示します。

6.54.1. add POST
リンクのコピー

データセンターに新しいネットワークを作成します。

以下の例のようなリクエストの後に、ID が 123 のデータセンターに新しいネットワークを作成します。

POST /ovirt-engine/api/datacenters/123/networks

POST /ovirt-engine/api/datacenters/123/networks

Copy to Clipboard

Toggle word wrap

ボディーで以下の例を使用します。

<network>
  <name>mynetwork</name>
</network>

<network>
  <name>mynetwork</name>
</network>

Copy to Clipboard

Toggle word wrap

Expand

表6.158 パラメーターの概要
名前	型	方向	Summary
`network`	Network	In/Out	データセンターで作成されるネットワークオブジェクト。

6.54.2. list GET
リンクのコピー

データセンター内のネットワークをリスト表示します。

返されるネットワークリストの順序は保証されません。

Expand

表6.159 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すネットワークの最大数を設定します。
`networks`	Network[]	Out	データセンターにあるネットワークのリスト。

6.54.2.1. follow
リンクのコピー

6.54.2.2. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

6.55. DataCenters
リンクのコピー

データセンターを管理するサービス

Expand

表6.160 メソッドの概要
名前	Summary
`add`	新しいデータセンターを作成します。
`list`	データセンターをリスト表示します。

6.55.1. add POST
リンクのコピー

新しいデータセンターを作成します。

新しいデータセンターを作成するには、name および local 要素が必要です。たとえば、共有ストレージ (NFS、iSCSI、またはファイバーチャネル) を使用する mydc という名前のデータセンターを作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/datacenters

POST /ovirt-engine/api/datacenters

Copy to Clipboard

Toggle word wrap

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

<data_center>
  <name>mydc</name>
  <local>false</local>
</data_center>

<data_center>
  <name>mydc</name>
  <local>false</local>
</data_center>

Copy to Clipboard

Toggle word wrap

Expand

表6.161 パラメーターの概要
名前	型	方向	Summary
`data_center`	DataCenter	In/Out	追加するデータセンター。

6.55.2. list GET
リンクのコピー

データセンターをリスト表示します。

以下の要求は、データセンターの表現を取得します。

GET /ovirt-engine/api/datacenters

GET /ovirt-engine/api/datacenters

Copy to Clipboard

Toggle word wrap

上記のリクエストは curl で実行されました:

curl \
--request GET \
--cacert /etc/pki/ovirt-engine/ca.pem \
--header "Version: 4" \
--header "Accept: application/xml" \
--user "admin@internal:mypassword" \
https://myengine.example.com/ovirt-engine/api/datacenters

curl \
--request GET \
--cacert /etc/pki/ovirt-engine/ca.pem \
--header "Version: 4" \
--header "Accept: application/xml" \
--user "admin@internal:mypassword" \
https://myengine.example.com/ovirt-engine/api/datacenters

Copy to Clipboard

Toggle word wrap

応答の例を以下に示します。

<data_center href="/ovirt-engine/api/datacenters/123" id="123">
  <name>Default</name>
  <description>The default Data Center</description>
  <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
  <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
  <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
  <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
  <local>false</local>
  <quota_mode>disabled</quota_mode>
  <status>up</status>
  <supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
  </supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
</data_center>

<data_center href="/ovirt-engine/api/datacenters/123" id="123">
  <name>Default</name>
  <description>The default Data Center</description>
  <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
  <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
  <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
  <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
  <local>false</local>
  <quota_mode>disabled</quota_mode>
  <status>up</status>
  <supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
  </supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
</data_center>

Copy to Clipboard

Toggle word wrap

Default データセンターの ID コードに注意してください。このコードは、仮想環境の他のリソースに関連して、このデータセンターを特定します。

データセンターには、ストレージドメインコレクションへのリンクも含まれています。データセンターはこのコレクションを使用して、ストレージドメインのメインコレクションからストレージドメインを割り当てます。

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

Expand

表6.162 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`data_centers`	DataCenter[]	Out
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すデータセンターの最大数を設定します。
`search`	String	In	返されたデータセンターを制限するために使用されるクエリー文字列。

6.55.2.1. case_sensitive
リンクのコピー

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

6.55.2.2. follow
リンクのコピー

6.55.2.3. max
リンクのコピー

返すデータセンターの最大数を設定します。指定されていない場合は、すべてのデータセンターが返されます。

6.56. ディスク
リンクのコピー

単一ディスクを管理します。

Expand

表6.163 メソッドの概要
名前	Summary
`convert`	ディスクフォーマットや事前割り当てモードを変換します。
`copy`	この操作により、指定されたストレージドメインにディスクをコピーします。
`export`	ディスクをエクスポートストレージドメインにエクスポートします。
`get`	ディスクの説明を取得します。
`move`	ディスクを別のストレージドメインに移動します。
`reduce`	ディスクイメージのサイズを縮小します。
`refreshlun`	ストレージの最新情報で直接 LUN ディスクを更新します。
`remove`	ディスクを削除します。
`sparsify`	ディスクをスパース化します。
`update`	指定されたディスクのパラメーターを更新します。

6.56.1. convert POST
リンクのコピー

ディスクフォーマットや事前割り当てモードを変換します。

たとえば、ディスク形式を preallocated-cow から sparse-raw イメージに変換するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/disks/123/convert

POST /ovirt-engine/api/disks/123/convert

Copy to Clipboard

Toggle word wrap

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

 <action>
   <disk>
     <sparse>true</sparse>
     <format>raw</format>
   </disk>
 </action>

 <action>
   <disk>
     <sparse>true</sparse>
     <format>raw</format>
   </disk>
 </action>

Copy to Clipboard

Toggle word wrap

注: ディスクをスパース化するには、ディスクがブロックストレージドメイン上にある場合、変換が 2 回必要になることがあります。例: ディスクが RAW の場合、QCOW に変換するとディスクが大きくなります。サイズを小さくするために、ディスクを再度 QCOW に変換し、同じ割り当てポリシーを維持することができます。

Expand

表6.164 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In	ディスクの説明。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.56.1.1. follow
リンクのコピー

6.56.2. copy POST
リンクのコピー

この操作により、指定されたストレージドメインにディスクをコピーします。

たとえば、以下の要求を使用してディスクをコピーすることができます。

POST /ovirt-engine/api/disks/123/copy

POST /ovirt-engine/api/disks/123/copy

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain id="456"/>
  <disk>
    <name>mydisk</name>
  </disk>
</action>

<action>
  <storage_domain id="456"/>
  <disk>
    <name>mydisk</name>
  </disk>
</action>

Copy to Clipboard

Toggle word wrap

ディスクプロファイルまたは現在ディスクが使用しているクォータが新規ストレージドメインに定義されていない場合は、明示的に指定できます。これらが指定されていない場合、最初に利用可能なディスクプロファイルとデフォルトのクォータが使用されます。

たとえば、ディスクプロファイル 987 とクォータ 753 を指定するには、以下のようなリクエスト本文を送信します。

<action>
  <storage_domain id="456"/>
  <disk_profile id="987"/>
  <quota id="753"/>
</action>

<action>
  <storage_domain id="456"/>
  <disk_profile id="987"/>
  <quota id="753"/>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.165 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	コピーを非同期的に実行するかどうかを指定します。
`disk`	ディスク	In
`disk_profile`	DiskProfile	In	新規ストレージドメインのディスクのディスクプロファイル。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`quota`	クォータ	In	新規ストレージドメインのディスクのクォータ。
`storage_domain`	StorageDomain	In	新しいディスクが作成されるストレージドメイン。

6.56.2.1. disk_profile
リンクのコピー

新規ストレージドメインのディスクのディスクプロファイル。

ディスクプロファイルはストレージドメインに定義されているため、古いディスクプロファイルは新しいストレージドメインに存在しません。このパラメーターを使用しない場合には、ユーザーにパーミッションがある新規ストレージドメインの最初のディスクプロファイルがディスクに割り当てられます。

6.56.2.2. quota
リンクのコピー

新規ストレージドメインのディスクのクォータ。

このオプションのパラメーターを使用して、ディスクの新しいクォータを指定できます。これは、現在のクォータが新しいストレージドメインに定義されていない可能性があるためです。このパラメーターが使用されず、古いクォータが新しいストレージドメインに定義されていない場合、デフォルトの (無制限の) クォータがディスクに割り当てられます。

6.56.2.3. storage_domain
リンクのコピー

新しいディスクが作成されるストレージドメイン。これは、id または name 属性を使用して指定できます。たとえば、mydata というストレージドメインにディスクをコピーするには、以下のように要求を送信します。

POST /ovirt-engine/api/storagedomains/123/disks/789

POST /ovirt-engine/api/storagedomains/123/disks/789

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
</action>

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
</action>

Copy to Clipboard

Toggle word wrap

6.56.3. export POST
リンクのコピー

ディスクをエクスポートストレージドメインにエクスポートします。

Expand

表6.166 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	エクスポートを非同期で実行する必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`storage_domain`	StorageDomain	In	ディスクがエクスポートされるエクスポートストレージドメイン。

6.56.4. get GET
リンクのコピー

ディスクの説明を取得します。

Expand

表6.167 パラメーターの概要
名前	型	方向	Summary
`all_content`	ブール値	In	ディスクのすべての属性を応答に含めるかどうかを指定します。
`disk`	ディスク	Out	ディスクの説明。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.56.4.1. all_content
リンクのコピー

ディスクのすべての属性を応答に含めるかどうかを指定します。

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

vms

たとえば、ディスク '123' の完全な表現を取得するには、以下のコマンドを実行します。

GET /ovirt-engine/api/disks/123?all_content=true

GET /ovirt-engine/api/disks/123?all_content=true

Copy to Clipboard

Toggle word wrap

6.56.4.2. follow
リンクのコピー

6.56.5. move POST
リンクのコピー

ディスクを別のストレージドメインに移動します。

たとえば、識別子 123 のディスクを、識別子 456 が指定されたストレージドメインに移動するには、以下のリクエストを送信します。

POST /ovirt-engine/api/disks/123/move

POST /ovirt-engine/api/disks/123/move

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain id="456"/>
</action>

<action>
  <storage_domain id="456"/>
</action>

Copy to Clipboard

Toggle word wrap

ディスクプロファイルまたはディスクで現在使用されているクォータが新しいストレージドメインに対して定義されていない場合は、それらを明示的に指定できます。そうでない場合は、最初に使用可能なディスクプロファイルとデフォルトのクォータが使用されます。

たとえば、ディスクプロファイル 987 とクォータ 753 を明示的に使用するには、次のようなリクエスト本文を送信します。

<action>
  <storage_domain id="456"/>
  <disk_profile id="987"/>
  <quota id="753"/>
</action>

<action>
  <storage_domain id="456"/>
  <disk_profile id="987"/>
  <quota id="753"/>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.168 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	移動を非同期で実行する必要があるかどうかを示します。
`disk_profile`	DiskProfile	In	新規ストレージドメインのディスクのディスクプロファイル。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`quota`	クォータ	In	新規ストレージドメインのディスクのクォータ。
`storage_domain`	StorageDomain	In	ディスクが移動されるストレージドメイン。

6.56.5.1. disk_profile
リンクのコピー

新規ストレージドメインのディスクのディスクプロファイル。

6.56.5.2. quota
リンクのコピー

新規ストレージドメインのディスクのクォータ。

6.56.6. reduce POST
リンクのコピー

ディスクイメージのサイズを縮小します。

論理ボリュームで縮小を呼び出します (つまり、ブロックストレージドメインにのみ適用されます)。これは、フローティングディスクおよび実行されていない仮想マシンに接続されているディスクに適用されます。最適なサイズは自動的に算出されるため、サイズを指定する必要はありません。

Expand

表6.169 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.56.7. refreshlun POST
リンクのコピー

ストレージの最新情報で直接 LUN ディスクを更新します。

直接 LUN ディスクの更新は、以下の場合に役に立ちます。

LUN はホストパラメーターなしで API を使用して追加されたため、ストレージからの情報は含まれていません (DisksService::add を参照)。
LUN に関する新しい情報がストレージで利用可能であり、それを使用して LUN を更新する必要があります。

ホスト 456 を使用して直接 LUN ディスク 123 を更新するには、以下の要求を送信します。

POST /ovirt-engine/api/disks/123/refreshlun

POST /ovirt-engine/api/disks/123/refreshlun

Copy to Clipboard

Toggle word wrap

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

<action>
  <host id='456'/>
</action>

<action>
  <host id='456'/>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.170 パラメーターの概要
名前	型	方向	Summary
`host`	ホスト	In	ダイレクト LUN ディスクの更新に使用されるホスト。

6.56.8. remove DELETE
リンクのコピー

ディスクを削除します。

Expand

表6.171 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.56.9. sparsify POST
リンクのコピー

ディスクをスパース化します。

Sparsification は、ファイルシステムで使用されていないディスクイメージのスペースを解放します。その結果、イメージはストレージの領域を減らします。

現在、スパース化はスナップショットのないディスクでのみ機能します。派生ディスクを持つディスクも許可されていません。

6.56.10. update PUT
リンクのコピー

指定されたディスクのパラメーターを更新します。

この操作により、次のフローティングディスクのプロパティーを更新できます。

イメージディスクの場合: provisioned_size、alias、description、wipe_after_delete、shareable、backup および disk_profile。
LUN ディスクの場合: alias、description および shareable。
Cinder 統合は、マネージドブロックストレージに置き換えられました。
マネージドブロックのディスクの場合: provisioned_size、alias および description。
VM 接続ディスクの場合は、qcow_version も更新できます。

たとえば、ディスクの更新は、次の要求を使用して実行できます。

PUT /ovirt-engine/api/disks/123

PUT /ovirt-engine/api/disks/123

Copy to Clipboard

Toggle word wrap

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

<disk>
  <qcow_version>qcow2_v3</qcow_version>
  <alias>new-alias</alias>
  <description>new-desc</description>
</disk>

<disk>
  <qcow_version>qcow2_v3</qcow_version>
  <alias>new-alias</alias>
  <description>new-desc</description>
</disk>

Copy to Clipboard

Toggle word wrap

バックエンド操作は非同期であるため、ユーザーに返されるディスク要素は、変更されたプロパティーと同期されない場合があります。

Expand

表6.172 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In/Out	ディスクに適用する更新。

6.57. DiskAttachment
リンクのコピー

このサービスは、仮想マシンへのディスクの接続を管理します。

Expand

表6.173 メソッドの概要
名前	Summary
`get`	起動フラグやディスクへのリンクなど、添付ファイルの詳細を返します。
`remove`	ディスクアタッチメントを削除します。
`update`	ディスクアタッチメントとその中のディスクプロパティーを更新します。

6.57.1. get GET
リンクのコピー

起動フラグやディスクへのリンクなど、添付ファイルの詳細を返します。

ディスク接続を取得する例:

GET /ovirt-engine/api/vms/123/diskattachments/456

GET /ovirt-engine/api/vms/123/diskattachments/456

Copy to Clipboard

Toggle word wrap

<disk_attachment href="/ovirt-engine/api/vms/123/diskattachments/456" id="456">
  <active>true</active>
  <bootable>true</bootable>
  <interface>virtio</interface>
  <disk href="/ovirt-engine/api/disks/456" id="456"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</disk_attachment>

<disk_attachment href="/ovirt-engine/api/vms/123/diskattachments/456" id="456">
  <active>true</active>
  <bootable>true</bootable>
  <interface>virtio</interface>
  <disk href="/ovirt-engine/api/disks/456" id="456"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

Expand

表6.174 パラメーターの概要
名前	型	方向	Summary
`attachment`	DiskAttachment	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.57.1.1. follow
リンクのコピー

6.57.2. remove DELETE
リンクのコピー

ディスクアタッチメントを削除します。

これにより、仮想マシンからディスクがデタッチされるだけで、detach_only パラメーターが false でない限り、システムからディスクが削除されることはありません。

ディスクアタッチメントを削除する例:

DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true

DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true

Copy to Clipboard

Toggle word wrap

Expand

表6.175 パラメーターの概要
名前	型	方向	Summary
`detach_only`	ブール値	In	ディスクを仮想マシンからのみ切り離す必要があり、システムからは切り離さないようにする必要があるかどうかを示します。

6.57.2.1. detach_only
リンクのコピー

ディスクを仮想マシンからのみ切り離す必要があり、システムからは切り離さないようにする必要があるかどうかを示します。デフォルト値は true で、システムからディスクを削除しません。

6.57.3. update PUT
リンクのコピー

ディスクアタッチメントとその中のディスクプロパティーを更新します。

PUT /vms/{vm:id}/disksattachments/{attachment:id}
<disk_attachment>
  <bootable>true</bootable>
  <interface>ide</interface>
  <active>true</active>
  <disk>
    <name>mydisk</name>
    <provisioned_size>1024</provisioned_size>
    ...
  </disk>
</disk_attachment>

PUT /vms/{vm:id}/disksattachments/{attachment:id}
<disk_attachment>
  <bootable>true</bootable>
  <interface>ide</interface>
  <active>true</active>
  <disk>
    <name>mydisk</name>
    <provisioned_size>1024</provisioned_size>
    ...
  </disk>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

Expand

表6.176 パラメーターの概要
名前	型	方向	Summary
`disk_attachment`	DiskAttachment	In/Out

6.58. DiskAttachments
リンクのコピー

このサービスは、仮想マシンにアタッチされている一連のディスクを管理します。アタッチされている各ディスクは、起動可能フラグ、ディスクインターフェイス、およびディスクへの参照を含む DiskAttachment で表されます。

Expand

表6.177 メソッドの概要
名前	Summary
`add`	仮想マシンに新しいディスクアタッチメントを追加します。
`list`	仮想マシンに接続されているディスクをリスト表示します。

6.58.1. add POST
リンクのコピー

仮想マシンに新しいディスクアタッチメントを追加します。ディスクがすでに存在する場合は、attachment パラメーターには参照のみを含めることができます。

<disk_attachment>
  <bootable>true</bootable>
  <pass_discard>true</pass_discard>
  <interface>ide</interface>
  <active>true</active>
  <disk id="123"/>
</disk_attachment>

<disk_attachment>
  <bootable>true</bootable>
  <pass_discard>true</pass_discard>
  <interface>ide</interface>
  <active>true</active>
  <disk id="123"/>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

または、ディスクがまだ存在しない場合には、ディスクの完全な表現を含めることができます。

<disk_attachment>
  <bootable>true</bootable>
  <pass_discard>true</pass_discard>
  <interface>ide</interface>
  <active>true</active>
  <disk>
    <name>mydisk</name>
    <provisioned_size>1024</provisioned_size>
    ...
  </disk>
</disk_attachment>

<disk_attachment>
  <bootable>true</bootable>
  <pass_discard>true</pass_discard>
  <interface>ide</interface>
  <active>true</active>
  <disk>
    <name>mydisk</name>
    <provisioned_size>1024</provisioned_size>
    ...
  </disk>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

この場合、ディスクが作成され、仮想マシンに割り当てられます。

いずれの場合も、ID 345 の仮想マシンに以下の URL を使用します。

POST /ovirt-engine/api/vms/345/diskattachments

POST /ovirt-engine/api/vms/345/diskattachments

Copy to Clipboard

Toggle word wrap

重要

サーバーは active 属性を含まないリクエストを受け入れますが、その効果は定義されていません。場合によっては、ディスクが自動的にアクティベートされ、その他の場合は自動的にアクティブになりません。問題を回避するには、希望の値で active 属性を常に含めることを強く推奨します。

Expand

表6.178 パラメーターの概要
名前	型	方向	Summary
`attachment`	DiskAttachment	In/Out	仮想マシンに追加するディスクアタッチメント。

6.58.2. list GET
リンクのコピー

仮想マシンに接続されているディスクをリスト表示します。

返されたディスク割り当てのリストの順序は保証されません。

Expand

表6.179 パラメーターの概要
名前	型	方向	Summary
`attachments`	DiskAttachment[]	Out	仮想マシンに割り当てられるディスク割り当てのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.58.2.1. follow
リンクのコピー

6.59. DiskProfile
リンクのコピー

Expand

表6.180 メソッドの概要
名前	Summary
`get`
`remove`
`update`	システムで指定したディスクプロファイルを更新します。

6.59.1. get GET
リンクのコピー

Expand

表6.181 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`profile`	DiskProfile	Out

6.59.1.1. follow
リンクのコピー

6.59.2. remove DELETE
リンクのコピー

Expand

表6.182 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.59.3. update PUT
リンクのコピー

システムで指定したディスクプロファイルを更新します。

Expand

表6.183 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`profile`	DiskProfile	In/Out

6.60. DiskProfiles
リンクのコピー

Expand

表6.184 メソッドの概要
名前	Summary
`add`	システムに新しいディスクプロファイルを追加します。
`list`	システムのディスクプロファイルリストを返します。

6.60.1. add POST
リンクのコピー

システムに新しいディスクプロファイルを追加します。

Expand

表6.185 パラメーターの概要
名前	型	方向	Summary
`profile`	DiskProfile	In/Out

6.60.2. list GET
リンクのコピー

システムのディスクプロファイルリストを返します。

返されるディスクプロファイルのリストの順序は保証されません。

Expand

表6.186 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロファイルの最大数を設定します。
`profile`	DiskProfile[]	Out

6.60.2.1. follow
リンクのコピー

6.60.2.2. max
リンクのコピー

返すプロファイルの最大数を設定します。指定されていない場合は、すべてのプロファイルが返されます。

6.61. DiskSnapshot
リンクのコピー

Expand

表6.187 メソッドの概要
名前	Summary
`get`
`remove`

6.61.1. get GET
リンクのコピー

Expand

表6.188 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`snapshot`	DiskSnapshot	Out

6.61.1.1. follow
リンクのコピー

6.61.2. remove DELETE
リンクのコピー

Expand

表6.189 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.62. DiskSnapshots
リンクのコピー

ストレージドメインで利用可能なディスクスナップショットのコレクションを管理します。

Expand

表6.190 メソッドの概要
名前	Summary
`list`	ストレージドメインのディスクスナップショットのリストを返します。

6.62.1. list GET
リンクのコピー

ストレージドメインのディスクスナップショットのリストを返します。

返されるディスクスナップショットのリストの順序は保証されません。

Expand

表6.191 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`include_active`	ブール値	In	true の場合は、アクティブなスナップショットも返します。
`include_template`	ブール値	In	true の場合は、テンプレートスナップショットも返します。
`max`	Integer	In	返すスナップショットの最大数を設定します。
`snapshots`	DiskSnapshot[]	Out

6.62.1.1. follow
リンクのコピー

6.62.1.2. include_active
リンクのコピー

true の場合は、アクティブなスナップショットも返します。指定されていない場合は、アクティブなスナップショットが返されません。

6.62.1.3. include_template
リンクのコピー

true の場合は、テンプレートスナップショットも返します。指定されていない場合には、テンプレートスナップショットが返されません。

6.62.1.4. max
リンクのコピー

返すスナップショットの最大数を設定します。指定されていない場合は、すべてのスナップショットが返されます。

6.63. ディスク
リンクのコピー

システムで利用可能なディスクのコレクションを管理します。

Expand

表6.192 メソッドの概要
名前	Summary
`add`	新しいフローティングディスクを追加します。
`list`	ディスクのリストを取得します。

6.63.1. add POST
リンクのコピー

新しいフローティングディスクを追加します。

追加できるディスクには、ディスクイメージ、ダイレクト LUN、マネージドブロックディスクの 3 種類があります。Cinder 統合は、マネージドブロックストレージに置き換えられました。

新しいイメージディスクの追加:

新しいフローティングイメージ Disk を作成する場合、API には storage_domain、provisioned_size、および format 属性が必要です。

ブロックストレージドメイン (つまり、ストレージタイプが iSCSI または FCP のストレージドメイン) は、raw format と sparse=true の組み合わせをサポートしていないため、sparse=false を明示的に指定する必要があることに注意してください。

ID が 123 で、増分バックアップが有効になっているストレージドメインに、provisioned_size、format、name を指定して新しいフローティングイメージディスクを作成するには、次のようにリクエストを送信します。

POST /ovirt-engine/api/disks

POST /ovirt-engine/api/disks

Copy to Clipboard

Toggle word wrap

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

<disk>
  <storage_domains>
    <storage_domain id="123"/>
  </storage_domains>
  <name>mydisk</name>
  <provisioned_size>1048576</provisioned_size>
  <format>cow</format>
  <backup>incremental</backup>
</disk>

<disk>
  <storage_domains>
    <storage_domain id="123"/>
  </storage_domains>
  <name>mydisk</name>
  <provisioned_size>1048576</provisioned_size>
  <format>cow</format>
  <backup>incremental</backup>
</disk>

Copy to Clipboard

Toggle word wrap

新規ダイレクト LUN ディスクの追加:

API を介して新しいフローティングダイレクト LUN を追加する場合、使用できるフレーバーは 2 つあります。

host 要素の場合: この場合、ホストは健全性チェック (たとえば、LUN が表示されていること) および LUN に関する基本情報 (たとえば、サイズやシリアル) を取得するために使用されます。
host 要素がない場合: この場合、操作はデータベースのみの操作となり、ストレージにはアクセスされません。

ID が 123、指定された alias、type、および ID が 456 の logical_unit (属性 address、port、target を持つ) の host 要素を持つ新しいフローティングダイレクト LUN ディスクを作成するには、次のようにリクエストを送信します。

POST /ovirt-engine/api/disks

POST /ovirt-engine/api/disks

Copy to Clipboard

Toggle word wrap

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

<disk>
  <alias>mylun</alias>
  <lun_storage>
    <host id="123"/>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="456">
        <address>10.35.10.20</address>
        <port>3260</port>
        <target>iqn.2017-01.com.myhost:444</target>
      </logical_unit>
    </logical_units>
  </lun_storage>
</disk>

<disk>
  <alias>mylun</alias>
  <lun_storage>
    <host id="123"/>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="456">
        <address>10.35.10.20</address>
        <port>3260</port>
        <target>iqn.2017-01.com.myhost:444</target>
      </logical_unit>
    </logical_units>
  </lun_storage>
</disk>

Copy to Clipboard

Toggle word wrap

ホストを使用せずに新しい Floating ダイレクト LUN ディスクを作成するには、host 要素を削除します。

新しい Cinder ディスクを追加します。

Cinder 統合は、マネージドブロックストレージに置き換えられました。

ディスクスナップショットをアップロードするためのフローティングディスクの追加:

エンジンのバージョン 4.2 以降、スナップショットでディスクをアップロードできます。この要求は、イメージチェーンのベースイメージを作成するために使用する必要があります (連続するディスクスナップショット (イメージ) は、スナップショットを作成するときに disk-attachments 要素を使用して作成する必要があります)。

ディスクは、アップロードされたイメージと同じディスク識別子とイメージ識別子で作成する必要があります。つまり、識別子はバックアッププロセスの一部として保存する必要があります。イメージ識別子は、qemu-img info コマンドを使用して取得することもできます。たとえば、ディスクイメージが b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img という名前のファイルに保存されている場合:

qemu-img info b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img
image: b548366b-fb51-4b41-97be-733c887fe305
file format: qcow2
virtual size: 1.0G (1073741824 bytes)
disk size: 196K
cluster_size: 65536
backing file: ad58716a-1fe9-481f-815e-664de1df04eb
backing file format: raw

$ qemu-img info b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img
image: b548366b-fb51-4b41-97be-733c887fe305
file format: qcow2
virtual size: 1.0G (1073741824 bytes)
disk size: 196K
cluster_size: 65536
backing file: ad58716a-1fe9-481f-815e-664de1df04eb
backing file format: raw

Copy to Clipboard

Toggle word wrap

上記の qemu-img info コマンドで取得したディスク ID とイメージ ID でディスクを作成するには、以下のように要求を送信します。

POST /ovirt-engine/api/disks

POST /ovirt-engine/api/disks

Copy to Clipboard

Toggle word wrap

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

<disk id="b7a4c6c5-443b-47c5-967f-6abc79675e8b">
  <image_id>b548366b-fb51-4b41-97be-733c887fe305</image_id>
  <storage_domains>
    <storage_domain id="123"/>
  </storage_domains>
  <name>mydisk</name>
  <provisioned_size>1048576</provisioned_size>
  <format>cow</format>
</disk>

<disk id="b7a4c6c5-443b-47c5-967f-6abc79675e8b">
  <image_id>b548366b-fb51-4b41-97be-733c887fe305</image_id>
  <storage_domains>
    <storage_domain id="123"/>
  </storage_domains>
  <name>mydisk</name>
  <provisioned_size>1048576</provisioned_size>
  <format>cow</format>
</disk>

Copy to Clipboard

Toggle word wrap

Expand

表6.193 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In/Out	ディスク。

6.63.2. list GET
リンクのコピー

ディスクのリストを取得します。

GET /ovirt-engine/api/disks

GET /ovirt-engine/api/disks

Copy to Clipboard

Toggle word wrap

以下のような XML 応答を取得します。

<disks>
  <disk id="123">
    <actions>...</actions>
    <name>MyDisk</name>
    <description>MyDisk description</description>
    <link href="/ovirt-engine/api/disks/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/disks/123/statistics" rel="statistics"/>
    <actual_size>5345845248</actual_size>
    <alias>MyDisk alias</alias>
    ...
    <status>ok</status>
    <storage_type>image</storage_type>
    <wipe_after_delete>false</wipe_after_delete>
    <disk_profile id="123"/>
    <quota id="123"/>
    <storage_domains>...</storage_domains>
  </disk>
  ...
</disks>

<disks>
  <disk id="123">
    <actions>...</actions>
    <name>MyDisk</name>
    <description>MyDisk description</description>
    <link href="/ovirt-engine/api/disks/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/disks/123/statistics" rel="statistics"/>
    <actual_size>5345845248</actual_size>
    <alias>MyDisk alias</alias>
    ...
    <status>ok</status>
    <storage_type>image</storage_type>
    <wipe_after_delete>false</wipe_after_delete>
    <disk_profile id="123"/>
    <quota id="123"/>
    <storage_domains>...</storage_domains>
  </disk>
  ...
</disks>

Copy to Clipboard

Toggle word wrap

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

Expand

表6.194 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`disks`	Disk[]	Out	取得されたディスクのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。
`search`	String	In	返されたディスクを制限するために使用されるクエリー文字列。

6.63.2.1. case_sensitive
リンクのコピー

6.63.2.2. follow
リンクのコピー

6.63.2.3. max
リンクのコピー

返すディスクの最大数を設定します。指定しない場合、すべてのディスクが返されます。

6.64. ドメイン
リンクのコピー

システム内の認証ドメインの詳細を表示するサービス

Expand

表6.195 メソッドの概要
名前	Summary
`get`	認証ドメイン情報を取得します。

6.64.1. get GET
リンクのコピー

認証ドメイン情報を取得します。

使用方法:

GET /ovirt-engine/api/domains/5678

GET /ovirt-engine/api/domains/5678

Copy to Clipboard

Toggle word wrap

ドメイン情報を返します。

<domain href="/ovirt-engine/api/domains/5678" id="5678">
  <name>internal-authz</name>
  <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
  <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
  <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
  <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
</domain>

<domain href="/ovirt-engine/api/domains/5678" id="5678">
  <name>internal-authz</name>
  <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
  <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
  <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
  <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
</domain>

Copy to Clipboard

Toggle word wrap

Expand

表6.196 パラメーターの概要
名前	型	方向	Summary
`domain`	ドメイン	Out	認証ドメイン。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.64.1.1. follow
リンクのコピー

6.65. DomainGroup
リンクのコピー

Expand

表6.197 メソッドの概要
名前	Summary
`get`

6.65.1. get GET
リンクのコピー

Expand

表6.198 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`get`	グループ	Out

6.65.1.1. follow
リンクのコピー

6.66. DomainGroups
リンクのコピー

Expand

表6.199 メソッドの概要
名前	Summary
`list`	グループリストを返します。

6.66.1. list GET
リンクのコピー

グループリストを返します。

返されたグループリストの順序は保証されません。

Expand

表6.200 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`グループ`	Group[]	Out
`max`	Integer	In	返すグループの最大数を設定します。
`search`	String	In	返されるグループを制限するために使用されるクエリー文字列。

6.66.1.1. case_sensitive
リンクのコピー

6.66.1.2. follow
リンクのコピー

6.66.1.3. max
リンクのコピー

返すグループの最大数を設定します。指定のない場合は、すべてのグループが返されます。

6.67. DomainUser
リンクのコピー

システム内のドメインユーザーを表示するサービス

Expand

表6.201 メソッドの概要
名前	Summary
`get`	ドメインユーザー情報を取得します。

6.67.1. get GET
リンクのコピー

ドメインユーザー情報を取得します。

使用方法:

GET /ovirt-engine/api/domains/5678/users/1234

GET /ovirt-engine/api/domains/5678/users/1234

Copy to Clipboard

Toggle word wrap

ドメインユーザー情報を返します。

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <namespace>*</namespace>
  <principal>admin</principal>
  <user_name>admin@internal-authz</user_name>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
  </domain>
  <groups/>
</user>

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <namespace>*</namespace>
  <principal>admin</principal>
  <user_name>admin@internal-authz</user_name>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
  </domain>
  <groups/>
</user>

Copy to Clipboard

Toggle word wrap

Expand

表6.202 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`user`	User	Out	ドメインユーザー。

6.67.1.1. follow
リンクのコピー

6.68. DomainUserGroups
リンクのコピー

AAA 内線番号のユーザーのグループメンバーシップを表示するサービス。

Expand

表6.203 メソッドの概要
名前	Summary
`list`	ユーザーがメンバーになっているグループのリストを返します。

6.68.1. list GET
リンクのコピー

ユーザーがメンバーになっているグループのリストを返します。

Expand

表6.204 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`グループ`	Group[]	Out	ユーザーがメンバーになっているグループのリスト。

6.68.1.1. follow
リンクのコピー

6.69. DomainUsers
リンクのコピー

システム内のすべてのドメインユーザーをリスト表示するサービス。

Expand

表6.205 メソッドの概要
名前	Summary
`list`	ドメイン内のすべてのユーザーをリスト表示します。

6.69.1. list GET
リンクのコピー

ドメイン内のすべてのユーザーをリスト表示します。

使用方法:

GET /ovirt-engine/api/domains/5678/users

GET /ovirt-engine/api/domains/5678/users

Copy to Clipboard

Toggle word wrap

ドメイン内のユーザーのリストを返します。

<users>
  <user href="/ovirt-engine/api/domains/5678/users/1234" id="1234">
    <name>admin</name>
    <namespace>*</namespace>
    <principal>admin</principal>
    <user_name>admin@internal-authz</user_name>
    <domain href="/ovirt-engine/api/domains/5678" id="5678">
      <name>internal-authz</name>
    </domain>
    <groups/>
  </user>
</users>

<users>
  <user href="/ovirt-engine/api/domains/5678/users/1234" id="1234">
    <name>admin</name>
    <namespace>*</namespace>
    <principal>admin</principal>
    <user_name>admin@internal-authz</user_name>
    <domain href="/ovirt-engine/api/domains/5678" id="5678">
      <name>internal-authz</name>
    </domain>
    <groups/>
  </user>
</users>

Copy to Clipboard

Toggle word wrap

返されるユーザーのリストの順序は保証されません。

Expand

表6.206 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すユーザーの最大数を設定します。
`search`	String	In	返されるユーザーを制限するために使用されるクエリー文字列。
`ユーザー`	User[]	Out	ドメイン内のユーザーのリスト。

6.69.1.1. case_sensitive
リンクのコピー

6.69.1.2. follow
リンクのコピー

6.69.1.3. max
リンクのコピー

返すユーザーの最大数を設定します。指定しない場合、すべてのユーザーが返されます。

6.70. ドメイン
リンクのコピー

システム内のすべての認証ドメインをリスト表示するサービス。

Expand

表6.207 メソッドの概要
名前	Summary
`list`	システム内のすべての認証ドメインをリスト表示します。

6.70.1. list GET
リンクのコピー

システム内のすべての認証ドメインをリスト表示します。

使用方法:

GET /ovirt-engine/api/domains

GET /ovirt-engine/api/domains

Copy to Clipboard

Toggle word wrap

ドメインのリストを返します。

<domains>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
    <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
    <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
    <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
    <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
  </domain>
</domains>

<domains>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
    <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
    <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
    <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
    <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
  </domain>
</domains>

Copy to Clipboard

Toggle word wrap

返されるドメインリストの順序は保証されません。

Expand

表6.208 パラメーターの概要
名前	型	方向	Summary
`domains`	Domain[]	Out	ドメインのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すドメインの最大数を設定します。

6.70.1.1. follow
リンクのコピー

6.70.1.2. max
リンクのコピー

返すドメインの最大数を設定します。指定されていない場合は、すべてのドメインが返されます。

6.71. EngineKatelloErrata
リンクのコピー

エンジンに割り当てられた Katello エラータを管理するサービスこの情報は Katello から取得されます。

Expand

表6.209 メソッドの概要
名前	Summary
`list`	Katello エラータの表現を取得します。

6.71.1. list GET
リンクのコピー

Katello エラータの表現を取得します。

GET /ovirt-engine/api/katelloerrata

GET /ovirt-engine/api/katelloerrata

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

Copy to Clipboard

Toggle word wrap

返されたエラータリストの順序は保証されません。

Expand

表6.210 パラメーターの概要
名前	型	方向	Summary
`errata`	KatelloErratum[]	Out	Katello エラータの表現。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すエラータの最大数を設定します。

6.71.1.1. follow
リンクのコピー

6.71.1.2. max
リンクのコピー

返すエラータの最大数を設定します。指定されていない場合は、すべてのエラータが返されます。

6.72. イベント
リンクのコピー

システムのイベントを管理するサービス。

Expand

表6.211 メソッドの概要
名前	Summary
`get`	イベントを取得します。
`remove`	内部監査ログからイベントを削除します。

6.72.1. get GET
リンクのコピー

イベントを取得します。

イベントの取得例:

GET /ovirt-engine/api/events/123

GET /ovirt-engine/api/events/123

Copy to Clipboard

Toggle word wrap

<event href="/ovirt-engine/api/events/123" id="123">
  <description>Host example.com was added by admin@internal-authz.</description>
  <code>42</code>
  <correlation_id>135</correlation_id>
  <custom_id>-1</custom_id>
  <flood_rate>30</flood_rate>
  <origin>oVirt</origin>
  <severity>normal</severity>
  <time>2016-12-11T11:13:44.654+02:00</time>
  <cluster href="/ovirt-engine/api/clusters/456" id="456"/>
  <host href="/ovirt-engine/api/hosts/789" id="789"/>
  <user href="/ovirt-engine/api/users/987" id="987"/>
</event>

<event href="/ovirt-engine/api/events/123" id="123">
  <description>Host example.com was added by admin@internal-authz.</description>
  <code>42</code>
  <correlation_id>135</correlation_id>
  <custom_id>-1</custom_id>
  <flood_rate>30</flood_rate>
  <origin>oVirt</origin>
  <severity>normal</severity>
  <time>2016-12-11T11:13:44.654+02:00</time>
  <cluster href="/ovirt-engine/api/clusters/456" id="456"/>
  <host href="/ovirt-engine/api/hosts/789" id="789"/>
  <user href="/ovirt-engine/api/users/987" id="987"/>
</event>

Copy to Clipboard

Toggle word wrap

イベントにある情報に応じてフィールドの数が変わることに注意してください。たとえば、ストレージドメイン関連のイベントの場合、ストレージドメインの参照と、このストレージドメインが置かれているデータセンターのリファレンスを取得します。

Expand

表6.212 パラメーターの概要
名前	型	方向	Summary
`event`	イベント	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.72.1.1. follow
リンクのコピー

6.72.2. remove DELETE
リンクのコピー

内部監査ログからイベントを削除します。

以下のリクエストを送信するとイベントを削除できます。

DELETE /ovirt-engine/api/events/123

DELETE /ovirt-engine/api/events/123

Copy to Clipboard

Toggle word wrap

Expand

表6.213 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.73. EventSubscription
リンクのコピー

システムの特定のイベントサブスクリプションを管理するサービス。

Expand

表6.214 メソッドの概要
名前	Summary
`get`	event-subscription に関する情報を取得します。
`remove`	event-subscription をシステムから削除します。

6.73.1. get GET
リンクのコピー

event-subscription に関する情報を取得します。

たとえば、ユーザー '123' のサブスクリプションに関する情報をイベント 'vm_console_detected' を取得するには、次のようにします。

GET /ovirt-engine/api/users/123/vm_console_detected

GET /ovirt-engine/api/users/123/vm_console_detected

Copy to Clipboard

Toggle word wrap

<event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/vm_console_detected">
  <event>vm_console_detected</event>
  <notification_method>smtp</notification_method>
  <user href="/ovirt-engine/api/users/123" id="123"/>
  <address>a@b.com</address>
</event-subscription>

<event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/vm_console_detected">
  <event>vm_console_detected</event>
  <notification_method>smtp</notification_method>
  <user href="/ovirt-engine/api/users/123" id="123"/>
  <address>a@b.com</address>
</event-subscription>

Copy to Clipboard

Toggle word wrap

Expand

表6.215 パラメーターの概要
名前	型	方向	Summary
`event_subscription`	EventSubscription	Out	event-subscription

6.73.2. remove DELETE
リンクのコピー

event-subscription をシステムから削除します。

たとえば、ユーザー 123 のサブスクリプションを vm_console_detected イベントから削除するには、以下を実行します。

DELETE /ovirt-engine/api/users/123/vm_console_detected

DELETE /ovirt-engine/api/users/123/vm_console_detected

Copy to Clipboard

Toggle word wrap

Expand

表6.216 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.74. EventSubscriptions
リンクのコピー

ユーザーのイベントサブスクリプションのコレクションを管理するサービスを表します。

Expand

表6.217 メソッドの概要
名前	Summary
`add`	システムに新しい event-subscription を追加します。
`list`	提供されたユーザーの event-subscriptions をリスト表示します。

6.74.1. add POST
リンクのコピー

システムに新しい event-subscription を追加します。

event-subscription は、ユーザーのコンテキストに常に追加されます。たとえば、ユーザー 123 の host_high_cpu_use に新しい event-subscription を追加し、通知を電子メールアドレス a@b.com に送信するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/users/123/eventsubscriptions

POST /ovirt-engine/api/users/123/eventsubscriptions

Copy to Clipboard

Toggle word wrap

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

<event_subscription>
    <event>host_high_cpu_use</event>
    <address>a@b.com</address>
</event_subscription>

<event_subscription>
    <event>host_high_cpu_use</event>
    <address>a@b.com</address>
</event_subscription>

Copy to Clipboard

Toggle word wrap

イベント名は新しい event-subscription エンティティーの ID になります (GET …/api/users/123/eventsubscriptions/host_high_cpu_use)。

要求の本文にはユーザー ID が指定されないことに注意してください。これは、ユーザー ID(この場合は 123) がコンテキストから API にすでに認識されているためです。また、event-subscription エンティティーには notification-method フィールドが含まれていますが、リクエスト本文にも提供されていないことにも注意してください。これは、SNMP 通知が API レイヤーでまだサポートされていないため、現在は常に SMTP に設定されているためです。

Expand

表6.218 パラメーターの概要
名前	型	方向	Summary
`event_subscription`	EventSubscription	In/Out	追加された event-subscription。

6.74.2. list GET
リンクのコピー

提供されたユーザーの event-subscriptions をリスト表示します。

たとえば、ユーザー 123 の event-subscriptions をリスト表示するには、以下を実行します。

GET /ovirt-engine/api/users/123/event-subscriptions

GET /ovirt-engine/api/users/123/event-subscriptions

Copy to Clipboard

Toggle word wrap

<event-subscriptions>
  <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/host_install_failed">
    <event>host_install_failed</event>
    <notification_method>smtp</notification_method>
    <user href="/ovirt-engine/api/users/123" id="123"/>
    <address>a@b.com</address>
  </event-subscription>
  <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/vm_paused">
    <event>vm_paused</event>
    <notification_method>smtp</notification_method>
    <user href="/ovirt-engine/api/users/123" id="123"/>
    <address>a@b.com</address>
  </event-subscription>
</event-subscriptions>

<event-subscriptions>
  <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/host_install_failed">
    <event>host_install_failed</event>
    <notification_method>smtp</notification_method>
    <user href="/ovirt-engine/api/users/123" id="123"/>
    <address>a@b.com</address>
  </event-subscription>
  <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/vm_paused">
    <event>vm_paused</event>
    <notification_method>smtp</notification_method>
    <user href="/ovirt-engine/api/users/123" id="123"/>
    <address>a@b.com</address>
  </event-subscription>
</event-subscriptions>

Copy to Clipboard

Toggle word wrap

Expand

表6.219 パラメーターの概要
名前	型	方向	Summary
`event_subscriptions`	EventSubscription[]	Out	指定されたユーザーの event-subscriptions のリスト
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すイベントサブスクリプションの最大数を設定します。

6.74.2.1. follow
リンクのコピー

6.74.2.2. max
リンクのコピー

返すイベントサブスクリプションの最大数を設定します。指定されていない場合は、event-subscriptions がすべて返されます。

6.75. Events
リンクのコピー

システムのイベントを管理するサービス。

Expand

表6.220 メソッドの概要
名前	Summary
`add`	外部イベントを内部監査ログに追加します。
`list`	イベントのリストを取得します。
`undelete`

6.75.1. add POST
リンクのコピー

外部イベントを内部監査ログに追加します。

これは、システムの管理者に関連するイベントを検出または生成する外部システムとの統合を目的としています。たとえば、外部監視ツールは、仮想マシンのゲストオペレーティングシステム内でファイルシステムがいっぱいであることを検出できる場合があります。このイベントは、以下のような要求を送信する内部監査ログに追加できます。

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
</event>

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
</event>

Copy to Clipboard

Toggle word wrap

イベントは特定のオブジェクトにリンクすることもできます。たとえば、上記のイベントは、vm リンクを使用して、発生した特定の仮想マシンにリンクできます。

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
  <vm id="aae98225-5b73-490d-a252-899209af17e9"/>
</event>

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
  <vm id="aae98225-5b73-490d-a252-899209af17e9"/>
</event>

Copy to Clipboard

Toggle word wrap

注記

前述の例の vm のようにリンクを使用する場合は、id 属性のみが許可されます。name 属性 (指定されている場合) は無視されます。

Expand

表6.221 パラメーターの概要
名前	型	方向	Summary
`event`	イベント	In/Out

6.75.2. list GET
リンクのコピー

イベントのリストを取得します。

GET /ovirt-engine/api/events

GET /ovirt-engine/api/events

Copy to Clipboard

Toggle word wrap

上記のリクエストに対して、以下のレスポンスを受け取ります。

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1e892ea9</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T12:14:34.541+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>User admin logged in.</description>
    <code>30</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
</events>

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1e892ea9</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T12:14:34.541+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>User admin logged in.</description>
    <code>30</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
</events>

Copy to Clipboard

Toggle word wrap

以下のイベントが発生します。

id="1": 管理ユーザーアカウントの API ログイン。
id="2": API は admin ユーザーアカウントからログアウトします。

返されるイベントのリストの順序は常に付与されます。sortby 句が search パラメーターに含まれている場合、イベントはその句に従って順序付けられます。sortby 句が含まれていない場合、イベントは id 属性の値でソートされ、値は最も高いものから順に並べ替えられます。これは、max パラメーターと組み合わせて、最新のイベントの取得を簡素化します。

GET /ovirt-engine/api/events?max=1

GET /ovirt-engine/api/events?max=1

Copy to Clipboard

Toggle word wrap

Expand

表6.222 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`events`	Event[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`from`	Integer	In	イベントを返すまでのイベントインデックスを示します。
`max`	Integer	In	返すイベントの最大数を設定します。
`search`	String	In	イベントサービスは、他のリソースサービスと同様に検索クエリーを提供します。

6.75.2.1. case_sensitive
リンクのコピー

6.75.2.2. follow
リンクのコピー

6.75.2.3. from
リンクのコピー

イベントを返すまでのイベントインデックスを示します。イベントのインデックスは厳密に増加されるため、このパラメーターを使用すると、より大きなインデックスを持つイベントのみが返されます。たとえば、以下のリクエストは 123 を超えるインデックスのイベントのみを返します。

GET /ovirt-engine/api/events?from=123

GET /ovirt-engine/api/events?from=123

Copy to Clipboard

Toggle word wrap

このパラメーターは任意です。指定されていない場合には、返される最初のイベントが最後に生成されます。

6.75.2.4. max
リンクのコピー

返すイベントの最大数を設定します。指定されていない場合は、すべてのイベントが返されます。

6.75.2.5. search
リンクのコピー

イベントサービスは、他のリソースサービスと同様に検索クエリーを提供します。

特定の重大度を指定して検索できます。

GET /ovirt-engine/api/events?search=severity%3Dnormal

GET /ovirt-engine/api/events?search=severity%3Dnormal

Copy to Clipboard

Toggle word wrap

上記のリクエストに対して、重大度が normal と等しいイベントのリストを取得します。

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>Affinity Rules Enforcement Manager started.</description>
    <code>10780</code>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:52:18.861+02:00</time>
  </event>
</events>

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>Affinity Rules Enforcement Manager started.</description>
    <code>10780</code>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:52:18.861+02:00</time>
  </event>
</events>

Copy to Clipboard

Toggle word wrap

仮想化環境は、一定期間後に大量のイベントを生成します。ただし、API は 1 つの検索クエリーのデフォルトイベントのみを表示します。デフォルト以外のものを表示するには、API は結果を検索クエリーで page コマンドを使用してページに分割します。次の検索クエリーは、sortby 句と組み合わせてページ値を使用して結果をページ分割するように API に指示します。

sortby time asc page 1

sortby time asc page 1

Copy to Clipboard

Toggle word wrap

以下の例は、イベントリソースをページ分割します。URL でエンコードされたリクエストは以下のとおりです。

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201

Copy to Clipboard

Toggle word wrap

ページ値を増やして、結果の次のページを表示します。

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202

Copy to Clipboard

Toggle word wrap

6.75.3. undelete POST
リンクのコピー

Expand

表6.223 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除解除を非同期的に実行するかどうかを示します。

6.76. ExternalComputeResource
リンクのコピー

単一の外部コンピュートリソースを管理します。

コンピュートリソースは、ホストの外部プロバイダーに関する用語です。外部プロバイダーは、プロビジョニングされたホストの登録先も把握する必要があります。エンジンのログイン詳細は、外部プロバイダー側でコンピュートリソースとして保存されます。

Expand

表6.224 メソッドの概要
名前	Summary
`get`	外部コンピュートリソースの詳細を取得します。

6.76.1. get GET
リンクのコピー

外部コンピュートリソースの詳細を取得します。

たとえば、プロバイダー 123 のコンピューティングリソース 234 の詳細を取得するには、次のようなリクエストを送信します。

GET /ovirt-engine/api/externalhostproviders/123/computeresources/234

GET /ovirt-engine/api/externalhostproviders/123/computeresources/234

Copy to Clipboard

Toggle word wrap

以下のような応答が返されます。

<external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
  <name>hostname</name>
  <provider>oVirt</provider>
  <url>https://hostname/api</url>
  <user>admin@internal</user>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_compute_resource>

<external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
  <name>hostname</name>
  <provider>oVirt</provider>
  <url>https://hostname/api</url>
  <user>admin@internal</user>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_compute_resource>

Copy to Clipboard

Toggle word wrap

Expand

表6.225 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`resource`	ExternalComputeResource	Out	外部コンピュートリソース情報

6.76.1.1. follow
リンクのコピー

6.77. ExternalComputeResources
リンクのコピー

外部コンピュートリソースのコレクションを管理します。

Expand

表6.226 メソッドの概要
名前	Summary
`list`	外部コンピュートリソースのリストを取得します。

6.77.1. list GET
リンクのコピー

外部コンピュートリソースのリストを取得します。

たとえば、外部ホストプロバイダー 123 のコンピュートリソースを取得するには、以下のような要求を送信します。

GET /ovirt-engine/api/externalhostproviders/123/computeresources

GET /ovirt-engine/api/externalhostproviders/123/computeresources

Copy to Clipboard

Toggle word wrap

以下のような応答が返されます。

<external_compute_resources>
  <external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
    <name>hostname</name>
    <provider>oVirt</provider>
    <url>https://address/api</url>
    <user>admin@internal</user>
    <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
   </external_compute_resource>
   ...
</external_compute_resources>

<external_compute_resources>
  <external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
    <name>hostname</name>
    <provider>oVirt</provider>
    <url>https://address/api</url>
    <user>admin@internal</user>
    <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
   </external_compute_resource>
   ...
</external_compute_resources>

Copy to Clipboard

Toggle word wrap

返されたコンピュートリソースのリストの順序は保証されません。

Expand

表6.227 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すリソースの最大数を設定します。
`resources`	ExternalComputeResource[]	Out	外部コンピューターリソースのリスト。

6.77.1.1. follow
リンクのコピー

6.77.1.2. max
リンクのコピー

返すリソースの最大数を設定します。指定されていない場合は、すべてのリソースが返されます。

6.78. ExternalDiscoveredHost
リンクのコピー

このサービスは、単一の検出されたホストを管理します。

Expand

表6.228 メソッドの概要
名前	Summary
`get`	検出されたホスト情報を取得します。

6.78.1. get GET
リンクのコピー

検出されたホスト情報を取得します。

Foreman などの外部プロバイダー管理システムで管理するホストに関する情報を取得します。この情報には、ホスト名、アドレス、サブネット、ベースイメージなどが含まれます。

たとえば、プロバイダー 123 からホスト 234 の詳細を取得するには、以下のような要求を送信します。

GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234

GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234

Copy to Clipboard

Toggle word wrap

結果は以下のようになります。

<external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/234" id="234">
 <name>mac001a4ad04040</name>
 <ip>10.34.67.43</ip>
 <last_report>2017-04-24 11:05:41 UTC</last_report>
 <mac>00:1a:4a:d0:40:40</mac>
 <subnet_name>sat0</subnet_name>
 <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_discovered_host>

<external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/234" id="234">
 <name>mac001a4ad04040</name>
 <ip>10.34.67.43</ip>
 <last_report>2017-04-24 11:05:41 UTC</last_report>
 <mac>00:1a:4a:d0:40:40</mac>
 <subnet_name>sat0</subnet_name>
 <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_discovered_host>

Copy to Clipboard

Toggle word wrap

Expand

表6.229 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`host`	ExternalDiscoveredHost	Out	ホストのハードウェアおよび設定情報。

6.78.1.1. follow
リンクのコピー

6.79. ExternalDiscoveredHosts
リンクのコピー

このサービスは、外部検出ホストを管理します。

Expand

表6.230 メソッドの概要
名前	Summary
`list`	検出されたホストの情報のリストを取得します。

6.79.1. list GET
リンクのコピー

検出されたホストの情報のリストを取得します。

検出されたホストは、Foreman などのサードパーティーのプロバイダーから取得されます。

プロバイダー 123 の検出されたホストをリスト表示するには、以下を送信します。

GET /ovirt-engine/api/externalhostproviders/123/discoveredhost

GET /ovirt-engine/api/externalhostproviders/123/discoveredhost

Copy to Clipboard

Toggle word wrap

<external_discovered_hosts>
 <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/456" id="456">
  <name>mac001a4ad04031</name>
  <ip>10.34.67.42</ip>
  <last_report>2017-04-24 11:05:41 UTC</last_report>
  <mac>00:1a:4a:d0:40:31</mac>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
 </external_discovered_host>
 <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/789" id="789">
  <name>mac001a4ad04040</name>
  <ip>10.34.67.43</ip>
  <last_report>2017-04-24 11:05:41 UTC</last_report>
  <mac>00:1a:4a:d0:40:40</mac>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
 </external_discovered_host>
 ...
</external_discovered_hosts>

<external_discovered_hosts>
 <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/456" id="456">
  <name>mac001a4ad04031</name>
  <ip>10.34.67.42</ip>
  <last_report>2017-04-24 11:05:41 UTC</last_report>
  <mac>00:1a:4a:d0:40:31</mac>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
 </external_discovered_host>
 <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/789" id="789">
  <name>mac001a4ad04040</name>
  <ip>10.34.67.43</ip>
  <last_report>2017-04-24 11:05:41 UTC</last_report>
  <mac>00:1a:4a:d0:40:40</mac>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
 </external_discovered_host>
 ...
</external_discovered_hosts>

Copy to Clipboard

Toggle word wrap

返されるホストリストの順序は保証されません。

Expand

表6.231 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hosts`	ExternalDiscoveredHost[]	Out	検出されたホストのリスト
`max`	Integer	In	返すホストの最大数を設定します。

6.79.1.1. follow
リンクのコピー

6.79.1.2. max
リンクのコピー

返すホストの最大数を設定します。指定されていない場合は、すべてのホストが返されます。

6.80. ExternalHost
リンクのコピー

Expand

表6.232 メソッドの概要
名前	Summary
`get`

6.80.1. get GET
リンクのコピー

Expand

表6.233 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`host`	ExternalHost	Out

6.80.1.1. follow
リンクのコピー

6.81. ExternalHostGroup
リンクのコピー

このサービスは、1 つのホストグループ情報を管理します。

ホストグループは、ホストプロバイダーの用語です。ホストグループには、新規検出されたホストに適用されるプロビジョニングの詳細が含まれます。サブネット、オペレーティングシステム、ドメインなどの情報

Expand

表6.234 メソッドの概要
名前	Summary
`get`	ホストグループ情報を取得します。

6.81.1. get GET
リンクのコピー

ホストグループ情報を取得します。

たとえば、プロバイダー 123 の hostgroup 234 の詳細を取得するには、以下のように要求を送信します。

GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234

GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234

Copy to Clipboard

Toggle word wrap

以下のような応答が返されます。

<external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
  <name>rhel7</name>
  <architecture_name>x86_64</architecture_name>
  <domain_name>s.com</domain_name>
  <operating_system_name>RedHat 7.3</operating_system_name>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_host_group>

<external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
  <name>rhel7</name>
  <architecture_name>x86_64</architecture_name>
  <domain_name>s.com</domain_name>
  <operating_system_name>RedHat 7.3</operating_system_name>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_host_group>

Copy to Clipboard

Toggle word wrap

Expand

表6.235 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`group`	ExternalHostGroup	Out	ホストグループ情報。

6.81.1.1. follow
リンクのコピー

6.82. ExternalHostGroups
リンクのコピー

このサービスは、ホストグループを管理します。

Expand

表6.236 メソッドの概要
名前	Summary
`list`	外部ホストプロバイダーからホストグループのリストを取得します。

6.82.1. list GET
リンクのコピー

外部ホストプロバイダーからホストグループのリストを取得します。

ホストグループはホストプロバイダーの用語です。ホストグループにはプロビジョニングの詳細が含まれます。この API は、外部プロバイダーによって公開されるすべてのホストグループを返します。

たとえば、プロバイダー 123 のすべてのホストグループの詳細を取得するには、以下のように要求を送信します。

GET /ovirt-engine/api/externalhostproviders/123/hostgroups

GET /ovirt-engine/api/externalhostproviders/123/hostgroups

Copy to Clipboard

Toggle word wrap

応答は以下のようになります。

<external_host_groups>
  <external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
    <name>rhel7</name>
    <architecture_name>x86_64</architecture_name>
    <domain_name>example.com</domain_name>
    <operating_system_name>RedHat 7.3</operating_system_name>
    <subnet_name>sat0</subnet_name>
    <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
  </external_host_group>
  ...
</external_host_groups>

<external_host_groups>
  <external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
    <name>rhel7</name>
    <architecture_name>x86_64</architecture_name>
    <domain_name>example.com</domain_name>
    <operating_system_name>RedHat 7.3</operating_system_name>
    <subnet_name>sat0</subnet_name>
    <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
  </external_host_group>
  ...
</external_host_groups>

Copy to Clipboard

Toggle word wrap

返されたホストグループのリストの順序は保証されません。

Expand

表6.237 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`グループ`	ExternalHostGroup[]	Out	外部ホストプロバイダーで利用可能なホストグループのリスト
`max`	Integer	In	返すグループの最大数を設定します。

6.82.1.1. follow
リンクのコピー

6.82.1.2. max
リンクのコピー

返すグループの最大数を設定します。指定のない場合は、すべてのグループが返されます。

6.83. ExternalHostProvider
リンクのコピー

Foreman や Satellite などの外部ホストのプロバイダーを表します。

詳細は、フォアマンのドキュメントを参照してください。詳細は、Satellite のドキュメントを参照してください。

Expand

表6.238 メソッドの概要
名前	Summary
`get`	外部ホストプロバイダー情報の取得ホストプロバイダー、Foreman または Satellite は ovirt の外部プロバイダーとして設定できます。
`importcertificates`	外部ホストプロバイダーの SSL 証明書をインポートします。
`remove`
`testconnectivity`	外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。
`update`	システム内の指定された外部ホストプロバイダーを更新します。

6.83.1. get GET
リンクのコピー

外部ホストプロバイダー情報の取得

ホストプロバイダー、Foreman または Satellite は ovirt の外部プロバイダーとして設定できます。ovirt に割り当てられた特定のホストプロバイダーに関する詳細は、この API を使用します。

たとえば、ホストプロバイダー 123 の詳細を取得するには、次のようなリクエストを送信します。

GET /ovirt-engine/api/externalhostproviders/123

GET /ovirt-engine/api/externalhostproviders/123

Copy to Clipboard

Toggle word wrap

応答は以下のようになります。

<external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123">
  <name>mysatellite</name>
  <requires_authentication>true</requires_authentication>
  <url>https://mysatellite.example.com</url>
  <username>admin</username>
</external_host_provider>

<external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123">
  <name>mysatellite</name>
  <requires_authentication>true</requires_authentication>
  <url>https://mysatellite.example.com</url>
  <username>admin</username>
</external_host_provider>

Copy to Clipboard

Toggle word wrap

Expand

表6.239 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`provider`	ExternalHostProvider	Out

6.83.1.1. follow
リンクのコピー

6.83.2. importcertificates POST
リンクのコピー

外部ホストプロバイダーの SSL 証明書をインポートします。

Expand

表6.240 パラメーターの概要
名前	型	方向	Summary
`certificates`	Certificate[]	In

6.83.3. remove DELETE
リンクのコピー

Expand

表6.241 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.83.4. testconnectivity POST
リンクのコピー

外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

Copy to Clipboard

Toggle word wrap

Expand

表6.242 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	テストを非同期で実行する必要があるかどうかを示します。

6.83.5. update PUT
リンクのコピー

システム内の指定された外部ホストプロバイダーを更新します。

Expand

表6.243 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`provider`	ExternalHostProvider	In/Out

6.84. ExternalHostProviders
リンクのコピー

Expand

表6.244 メソッドの概要
名前	Summary
`add`	新しい外部ホストプロバイダーをシステムに追加します。
`list`	外部ホストプロバイダーのリストを返します。

6.84.1. add POST
リンクのコピー

新しい外部ホストプロバイダーをシステムに追加します。

Expand

表6.245 パラメーターの概要
名前	型	方向	Summary
`provider`	ExternalHostProvider	In/Out

6.84.2. list GET
リンクのコピー

外部ホストプロバイダーのリストを返します。

返されるホストプロバイダーのリストの順序は保証されません。

Expand

表6.246 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロバイダーの最大数を設定します。
`providers`	ExternalHostProvider[]	Out
`search`	String	In	返される外部ホストプロバイダーを制限するために使用されるクエリー文字列。

6.84.2.1. follow
リンクのコピー

6.84.2.2. max
リンクのコピー

返すプロバイダーの最大数を設定します。指定しない場合は、すべてのプロバイダーが返されます。

6.85. ExternalHosts
リンクのコピー

Expand

表6.247 メソッドの概要
名前	Summary
`list`	外部ホストのリストを返します。

6.85.1. list GET
リンクのコピー

外部ホストのリストを返します。

返されるホストリストの順序は保証されません。

Expand

表6.248 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hosts`	ExternalHost[]	Out
`max`	Integer	In	返すホストの最大数を設定します。

6.85.1.1. follow
リンクのコピー

6.85.1.2. max
リンクのコピー

返すホストの最大数を設定します。指定されていない場合は、すべてのホストが返されます。

6.86. ExternalNetworkProviderConfiguration
リンクのコピー

ホスト上のシステムによって外部ネットワークプロバイダーがどのようにプロビジョニングされるかを説明します。

Expand

表6.249 メソッドの概要
名前	Summary
`get`	ホスト上の外部ネットワークプロバイダーに関する情報を返します。

6.86.1. get GET
リンクのコピー

ホスト上の外部ネットワークプロバイダーに関する情報を返します。

Expand

表6.250 パラメーターの概要
名前	型	方向	Summary
`configuration`	ExternalNetworkProviderConfiguration	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.86.1.1. follow
リンクのコピー

6.87. ExternalNetworkProviderConfigurations
リンクのコピー

ホスト上のシステムによってプロビジョニングされたすべての外部ネットワークプロバイダーをリスト表示するサービス。

Expand

表6.251 メソッドの概要
名前	Summary
`list`	ホスト上のすべての外部ネットワークプロバイダーのリストを返します。

6.87.1. list GET
リンクのコピー

ホスト上のすべての外部ネットワークプロバイダーのリストを返します。

返されたネットワークのリストの順序は保証されません。

Expand

表6.252 パラメーターの概要
名前	型	方向	Summary
`configurations`	ExternalNetworkProviderConfiguration[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.87.1.1. follow
リンクのコピー

6.88. ExternalProvider
リンクのコピー

外部プロバイダーを管理する機能を提供します。

Expand

表6.253 メソッドの概要
名前	Summary
`importcertificates`	外部ホストプロバイダーの SSL 証明書をインポートします。
`testconnectivity`	外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。

6.88.1. importcertificates POST
リンクのコピー

外部ホストプロバイダーの SSL 証明書をインポートします。

Expand

表6.254 パラメーターの概要
名前	型	方向	Summary
`certificates`	Certificate[]	In

6.88.2. testconnectivity POST
リンクのコピー

外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

Copy to Clipboard

Toggle word wrap

Expand

表6.255 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	テストを非同期で実行する必要があるかどうかを示します。

6.89. ExternalProviderCertificate
リンクのコピー

外部プロバイダーの特定の証明書を表示するサービス。

Expand

表6.256 メソッドの概要
名前	Summary
`get`	特定の証明書を取得します。

6.89.1. get GET
リンクのコピー

特定の証明書を取得します。

GET /ovirt-engine/api/externalhostproviders/123/certificate/0

GET /ovirt-engine/api/externalhostproviders/123/certificate/0

Copy to Clipboard

Toggle word wrap

応答の例を以下に示します。

<certificate id="0">
  <organization>provider.example.com</organization>
  <subject>CN=provider.example.com</subject>
  <content>...</content>
</certificate>

<certificate id="0">
  <organization>provider.example.com</organization>
  <subject>CN=provider.example.com</subject>
  <content>...</content>
</certificate>

Copy to Clipboard

Toggle word wrap

Expand

表6.257 パラメーターの概要
名前	型	方向	Summary
`certificate`	証明書	Out	証明書の詳細。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.89.1.1. follow
リンクのコピー

6.90. ExternalProviderCertificates
リンクのコピー

外部プロバイダーの証明書を表示するサービス。

Expand

表6.258 メソッドの概要
名前	Summary
`list`	外部プロバイダーによって提示された証明書のチェーンを返します。

6.90.1. list GET
リンクのコピー

外部プロバイダーによって提示された証明書のチェーンを返します。

GET /ovirt-engine/api/externalhostproviders/123/certificates

GET /ovirt-engine/api/externalhostproviders/123/certificates

Copy to Clipboard

Toggle word wrap

応答の例を以下に示します。

<certificates>
  <certificate id="789">...</certificate>
  ...
</certificates>

<certificates>
  <certificate id="789">...</certificate>
  ...
</certificates>

Copy to Clipboard

Toggle word wrap

返される証明書の順序は常に署名の順序であることが保証されます。最初はサーバー自体の証明書であり、2 番目は最初に署名する CA の証明書です。

Expand

表6.259 パラメーターの概要
名前	型	方向	Summary
`certificates`	Certificate[]	Out	証明書の詳細を含むリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す証明書の最大数を設定します。

6.90.1.1. follow
リンクのコピー

6.90.1.2. max
リンクのコピー

返す証明書の最大数を設定します。指定しない場合は、すべての証明書が返されます。

6.91. ExternalTemplateImports
リンクのコピー

外部テンプレートをインポートする機能を提供します。現在、OVA のみをサポートしています。

Expand

表6.260 メソッドの概要
名前	Summary
`add`	この操作は、外部ハイパーバイザーからテンプレートをインポートするために使用されます。

6.91.1. add POST
リンクのコピー

この操作は、外部ハイパーバイザーからテンプレートをインポートするために使用されます。

たとえば、テンプレート OVA のインポートは、次のリクエストを使用して簡単に行うことができます。

POST /externaltemplateimports

POST /externaltemplateimports

Copy to Clipboard

Toggle word wrap

タイプ ExternalTemplateImport のリクエスト本文の場合、次に例を示します。

<external_template_import>
  <template>
    <name>my_template</name>
  </template>
  <cluster id="2b18aca2-4469-11eb-9449-482ae35a5f83" />
  <storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
  <url>ova:///mnt/ova/ova_template.ova</url>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
</external_template_import>

<external_template_import>
  <template>
    <name>my_template</name>
  </template>
  <cluster id="2b18aca2-4469-11eb-9449-482ae35a5f83" />
  <storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
  <url>ova:///mnt/ova/ova_template.ova</url>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
</external_template_import>

Copy to Clipboard

Toggle word wrap

Expand

表6.261 パラメーターの概要
名前	型	方向	Summary
`import`	ExternalTemplateImport	In/Out

6.92. ExternalVmImports
リンクのコピー

外部仮想マシンをインポートする機能を提供します。

Expand

表6.262 メソッドの概要
名前	Summary
`add`	この操作は、KVM、XEN、VMware などの外部ハイパーバイザーから仮想マシンをインポートするために使用されます。

6.92.1. add POST
リンクのコピー

この操作は、KVM、XEN、VMware などの外部ハイパーバイザーから仮想マシンをインポートするために使用されます。

たとえば、VMware からの仮想マシンのインポートは、次のリクエストを使用して簡単に行うことができます。

POST /externalvmimports

POST /externalvmimports

Copy to Clipboard

Toggle word wrap

タイプ ExternalVmImport のリクエスト本文の場合、次に例を示します。

<external_vm_import>
  <vm>
    <name>my_vm</name>
  </vm>
  <cluster id="360014051136c20574f743bdbd28177fd" />
  <storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
  <name>vm_name_as_is_in_vmware</name>
  <sparse>true</sparse>
  <username>vmware_user</username>
  <password>123456</password>
  <provider>VMWARE</provider>
  <url>vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1</url>
  <drivers_iso id="virtio-win-1.6.7.iso" />
</external_vm_import>

<external_vm_import>
  <vm>
    <name>my_vm</name>
  </vm>
  <cluster id="360014051136c20574f743bdbd28177fd" />
  <storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
  <name>vm_name_as_is_in_vmware</name>
  <sparse>true</sparse>
  <username>vmware_user</username>
  <password>123456</password>
  <provider>VMWARE</provider>
  <url>vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1</url>
  <drivers_iso id="virtio-win-1.6.7.iso" />
</external_vm_import>

Copy to Clipboard

Toggle word wrap

Expand

表6.263 パラメーターの概要
名前	型	方向	Summary
`import`	ExternalVmImport	In/Out

6.93. FenceAgent
リンクのコピー

特定のホストのフェンスエージェントを管理するサービス。

Expand

表6.264 メソッドの概要
名前	Summary
`get`	このフェンスエージェントの詳細を取得します。
`remove`	特定ホストのフェンスエージェントを削除します。
`update`	fencing-agent を更新します。

6.93.1. get GET
リンクのコピー

このフェンスエージェントの詳細を取得します。

GET /ovirt-engine/api/hosts/123/fenceagents/0

GET /ovirt-engine/api/hosts/123/fenceagents/0

Copy to Clipboard

Toggle word wrap

応答の例を以下に示します。

<agent id="0">
  <type>apc</type>
  <order>1</order>
  <ip>192.168.1.101</ip>
  <user>user</user>
  <password>xxx</password>
  <port>9</port>
  <options>name1=value1, name2=value2</options>
</agent>

<agent id="0">
  <type>apc</type>
  <order>1</order>
  <ip>192.168.1.101</ip>
  <user>user</user>
  <password>xxx</password>
  <port>9</port>
  <options>name1=value1, name2=value2</options>
</agent>

Copy to Clipboard

Toggle word wrap

Expand

表6.265 パラメーターの概要
名前	型	方向	Summary
`agent`	エージェント	Out	フェンスエージェントの詳細。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.93.1.1. follow
リンクのコピー

6.93.2. remove DELETE
リンクのコピー

特定ホストのフェンスエージェントを削除します。

DELETE /ovirt-engine/api/hosts/123/fenceagents/0

DELETE /ovirt-engine/api/hosts/123/fenceagents/0

Copy to Clipboard

Toggle word wrap

Expand

表6.266 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.93.3. update PUT
リンクのコピー

fencing-agent を更新します。

Expand

表6.267 パラメーターの概要
名前	型	方向	Summary
`agent`	エージェント	In/Out	フェンスエージェントの詳細。
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。

6.94. FenceAgents
リンクのコピー

特定のホストのフェンスエージェントを管理するサービス。

Expand

表6.268 メソッドの概要
名前	Summary
`add`	ホストに新しい fencing-agent を追加します。
`list`	ホストに設定されたフェンシングエージェントのリストを返します。

6.94.1. add POST
リンクのコピー

ホストに新しい fencing-agent を追加します。

POST /ovirt-engine/api/hosts/123/fenceagents

You should consult the /usr/sbin/fence_<agent_name> manual page for
the legal parameters to [name1=value1, name2=value2,...] in the options field.
If any parameter in options appears by name that means that it is mandatory.
For example in <options>slot=7[,name1=value1, name2=value2,...]</options>
slot is mandatory.

POST /ovirt-engine/api/hosts/123/fenceagents

You should consult the /usr/sbin/fence_<agent_name> manual page for
the legal parameters to [name1=value1, name2=value2,...] in the options field.
If any parameter in options appears by name that means that it is mandatory.
For example in <options>slot=7[,name1=value1, name2=value2,...]</options>
slot is mandatory.

Copy to Clipboard

Toggle word wrap

apc、bladecenter、wti フェンシングエージェントのサンプルリクエスト:

  <agent>
    <type>apc</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>slot=7[,name1=value1, name2=value2,...]</options>
  </agent>

  <agent>
    <type>apc</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>slot=7[,name1=value1, name2=value2,...]</options>
  </agent>

Copy to Clipboard

Toggle word wrap

apc_snmp、hpblade、ilo、ilo2、ilo_ssh、redfish、rsa フェンシングエージェントのサンプルリクエスト:

  <agent>
    <type>apc_snmp</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>[name1=value1, name2=value2,...]</options>
  </agent>

  <agent>
    <type>apc_snmp</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>[name1=value1, name2=value2,...]</options>
  </agent>

Copy to Clipboard

Toggle word wrap

cisco_ucs、drac5、eps フェンシングエージェントのサンプルリクエスト:

  <agent>
    <type>cisco_ucs</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <options>slot=7[,name1=value1, name2=value2,...]</options>
  </agent>

  <agent>
    <type>cisco_ucs</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <options>slot=7[,name1=value1, name2=value2,...]</options>
  </agent>

Copy to Clipboard

Toggle word wrap

drac7、ilo3、ilo4、ipmilan、rsb フェンシングエージェントのサンプルリクエスト:

  <agent>
    <type>drac7</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <options>[name1=value1, name2=value2,...]</options>
  </agent>

  <agent>
    <type>drac7</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <options>[name1=value1, name2=value2,...]</options>
  </agent>

Copy to Clipboard

Toggle word wrap

Expand

表6.269 パラメーターの概要
名前	型	方向	Summary
`agent`	エージェント	In/Out

6.94.2. list GET
リンクのコピー

ホストに設定されたフェンシングエージェントのリストを返します。

GET /ovirt-engine/api/hosts/123/fenceagents

GET /ovirt-engine/api/hosts/123/fenceagents

Copy to Clipboard

Toggle word wrap

応答の例を以下に示します。

<agents>
  <agent id="0">
    <type>apc</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>name1=value1, name2=value2</options>
  </agent>
</agents>

<agents>
  <agent id="0">
    <type>apc</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>name1=value1, name2=value2</options>
  </agent>
</agents>

Copy to Clipboard

Toggle word wrap

返されたフェンシングエージェントのリストの順序は保証されません。

Expand

表6.270 パラメーターの概要
名前	型	方向	Summary
`agents`	Agent[]	Out	フェンスエージェントの詳細のリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すエージェントの最大数を設定します。

6.94.2.1. follow
リンクのコピー

6.94.2.2. max
リンクのコピー

返すエージェントの最大数を設定します。指定しない場合、すべてのエージェントが返されます。

6.95. File
リンクのコピー

Expand

表6.271 メソッドの概要
名前	Summary
`get`

6.95.1. get GET
リンクのコピー

Expand

表6.272 パラメーターの概要
名前	型	方向	Summary
`file`	File	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.95.1.1. follow
リンクのコピー

6.96. ファイル
リンクのコピー

クライアントが利用可能なファイルをリスト表示する方法を提供します。

このサービスは、管理者がアップロードする ISO イメージと仮想フロッピーディスク (VFD) を含む ISO ストレージドメインを特に対象としています。

CD-ROM デバイスを仮想マシンに追加するには、ISO ストレージドメインのファイルからの ISO イメージが必要です。

Expand

表6.273 メソッドの概要
名前	Summary
`list`	ストレージドメインで利用可能な ISO イメージおよび仮想フロッピーのディスクリストを返します。

6.96.1. list GET
リンクのコピー

ストレージドメインで利用可能な ISO イメージおよび仮想フロッピーのディスクリストを返します。返されるリストの順序は保証されません。

refresh パラメーターが false の場合、返されるリストはストレージドメインへの最近の変更を反映していない可能性があります。たとえば、最近追加された新しい ISO ファイルが含まれていない場合があります。これは、サーバーがファイルのリストをキャッシュしてパフォーマンスを向上するためです。最新の結果を取得するには、refresh パラメーターを true に設定します。

refresh パラメーターのデフォルト値は true ですが、ForceRefreshDomainFilesByDefault 値を使用して変更できます。

engine-config -s ForceRefreshDomainFilesByDefault=false

# engine-config -s ForceRefreshDomainFilesByDefault=false

Copy to Clipboard

Toggle word wrap

重要

refresh パラメーターの値を true に設定すると、サーバーのパフォーマンスに影響します。必要な場合にのみ使用してください。

Expand

表6.274 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行した検索を討すべきかどうかを示します。
`file`	File[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すファイルの最大数を設定します。
`refresh`	ブール値	In	特定の間隔で更新されるキャッシュされた結果を表示するのではなく、ファイルのリストをストレージドメインから更新する必要があるかどうかを示します。
`search`	String	In	返されたファイルを制限するために使用されるクエリー文字列。

6.96.1.1. case_sensitive
リンクのコピー

search パラメーターを使用して実行した検索を討すべきかどうかを示します。デフォルト値は true です。

6.96.1.2. follow
リンクのコピー

6.96.1.3. max
リンクのコピー

返すファイルの最大数を設定します。指定のない場合は、すべてのファイルが返されます。

6.97. Filter
リンクのコピー

Expand

表6.275 メソッドの概要
名前	Summary
`get`
`remove`

6.97.1. get GET
リンクのコピー

Expand

表6.276 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`result`	Filter	Out

6.97.1.1. follow
リンクのコピー

6.97.2. remove DELETE
リンクのコピー

Expand

表6.277 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.98. Filters
リンクのコピー

スケジューリングポリシーで使用されるフィルターを管理します。

Expand

表6.278 メソッドの概要
名前	Summary
`add`	指定したユーザー定義のスケジューリングポリシーにフィルターを追加します。
`list`	スケジューリングポリシーで使用されるフィルターのリストを返します。

6.98.1. add POST
リンクのコピー

指定したユーザー定義のスケジューリングポリシーにフィルターを追加します。

Expand

表6.279 パラメーターの概要
名前	型	方向	Summary
`filter`	Filter	In/Out

6.98.2. list GET
リンクのコピー

スケジューリングポリシーで使用されるフィルターのリストを返します。

返されるフィルターのリストの順序は保証されません。

Expand

表6.280 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`filters`	Filter[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すフィルターの最大数を設定します。

6.98.2.1. follow
リンクのコピー

6.98.2.2. max
リンクのコピー

返すフィルターの最大数を設定します。指定しない場合、すべてのエージェントが返されます。

6.99. フォロー
リンクのコピー

6.100. GlusterBrick
リンクのコピー

このサービスは単一の gluster ブリックを管理します。

Expand

表6.281 メソッドの概要
名前	Summary
`get`	ブリックの詳細を取得します。
`remove`	ブリックを削除します。
`replace`	このブリックを新しいものに置き換えます。

6.100.1. get GET
リンクのコピー

ブリックの詳細を取得します。

ヘッダー All-Content が true に設定された基礎となる gluster ボリュームから、ステータスの詳細を取得します。これは、gluster volume status <volumename> <brickname> detail を実行するのと同じです。

たとえば、gluster ボリューム 123 の brick234 の詳細を取得するには、次のようなリクエストを送信します。

GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234

GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234

Copy to Clipboard

Toggle word wrap

これにより、以下のような応答ボディーが返されます。

<brick id="234">
  <name>host1:/rhgs/data/brick1</name>
  <brick_dir>/rhgs/data/brick1</brick_dir>
  <server_id>111</server_id>
  <status>up</status>
  <device>/dev/mapper/RHGS_vg1-lv_vmaddldisks</device>
  <fs_name>xfs</fs_name>
  <gluster_clients>
    <gluster_client>
      <bytes_read>2818417648</bytes_read>
      <bytes_written>1384694844</bytes_written>
      <client_port>1011</client_port>
      <host_name>client2</host_name>
    </gluster_client>
  </gluster_clients>
  <memory_pools>
    <memory_pool>
      <name>data-server:fd_t</name>
      <alloc_count>1626348</alloc_count>
      <cold_count>1020</cold_count>
      <hot_count>4</hot_count>
      <max_alloc>23</max_alloc>
      <max_stdalloc>0</max_stdalloc>
      <padded_size>140</padded_size>
      <pool_misses>0</pool_misses>
    </memory_pool>
  </memory_pools>
  <mnt_options>rw,seclabel,noatime,nodiratime,attr2,inode64,sunit=512,swidth=2048,noquota</mnt_options>
  <pid>25589</pid>
  <port>49155</port>
</brick>

<brick id="234">
  <name>host1:/rhgs/data/brick1</name>
  <brick_dir>/rhgs/data/brick1</brick_dir>
  <server_id>111</server_id>
  <status>up</status>
  <device>/dev/mapper/RHGS_vg1-lv_vmaddldisks</device>
  <fs_name>xfs</fs_name>
  <gluster_clients>
    <gluster_client>
      <bytes_read>2818417648</bytes_read>
      <bytes_written>1384694844</bytes_written>
      <client_port>1011</client_port>
      <host_name>client2</host_name>
    </gluster_client>
  </gluster_clients>
  <memory_pools>
    <memory_pool>
      <name>data-server:fd_t</name>
      <alloc_count>1626348</alloc_count>
      <cold_count>1020</cold_count>
      <hot_count>4</hot_count>
      <max_alloc>23</max_alloc>
      <max_stdalloc>0</max_stdalloc>
      <padded_size>140</padded_size>
      <pool_misses>0</pool_misses>
    </memory_pool>
  </memory_pools>
  <mnt_options>rw,seclabel,noatime,nodiratime,attr2,inode64,sunit=512,swidth=2048,noquota</mnt_options>
  <pid>25589</pid>
  <port>49155</port>
</brick>

Copy to Clipboard

Toggle word wrap

Expand

表6.282 パラメーターの概要
名前	型	方向	Summary
`brick`	GlusterBrick	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.100.1.1. follow
リンクのコピー

6.100.2. remove DELETE
リンクのコピー

ブリックを削除します。

基礎となる gluster ボリュームからブリックを削除し、データベースからエントリーを削除します。これは、データ移行なしで単一のブリックを削除する場合にのみ使用できます。複数のブリックとデータ移行を削除するには、代わりに migrate を使用します。

たとえば、gluster ボリューム 123 からブリック 234 を削除するには、以下のように要求を送信します。

DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234

DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234

Copy to Clipboard

Toggle word wrap

Expand

表6.283 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.100.3. replace POST
リンクのコピー

このブリックを新しいものに置き換えます。

重要

この操作はエンジンのバージョン 3.5 以降非推奨となり、今後削除されます。代わりに、add brick を使用してブリックを migrate brick します。

Expand

表6.284 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	代替を非同期的に実行するかどうかを指定します。
`force`	ブール値	In

6.101. GlusterBricks
リンクのコピー

このサービスは、gluster ボリュームで gluster ブリックを管理します。

Expand

表6.285 メソッドの概要
名前	Summary
`activate`	削除操作のデータ移行の後のデータ移行をアクティベートします。
`add`	gluster ボリュームに、ブリックのリストを追加します。
`list`	gluster ボリュームのブリックをリスト表示します。
`migrate`	ブリックを削除する前にデータの移行を開始します。
`remove`	gluster ボリュームからブリックを削除します。
`stopmigrate`	削除のブリック操作に関するデータのブリックからの移行を停止します。

6.101.1. activate POST
リンクのコピー

削除操作のデータ移行の後のデータ移行をアクティベートします。

ブリックからのデータ移行が完了し、ユーザーがブリックを削除したくないと、ブリックをアクティベートするために使用されます。削除用に以前にマークされていたブリックは、通常のブリックとして使用されるようになりました。

たとえば、データの移行元である glustervolume 123 のブリックを保持するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/activate

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/activate

Copy to Clipboard

Toggle word wrap

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

<action>
  <bricks>
    <brick>
      <name>host1:/rhgs/brick1</name>
    </brick>
  </bricks>
</action>

<action>
  <bricks>
    <brick>
      <name>host1:/rhgs/brick1</name>
    </brick>
  </bricks>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.286 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクティベーションを非同期で実行する必要があるかどうかを示します。
`ブリック`	GlusterBrick[]	In	再アクティベートする必要があるブリックのリスト。

6.101.2. add POST
リンクのコピー

gluster ボリュームに、ブリックのリストを追加します。

ブリックを追加して gluster ボリュームを拡張するのに使用します。複製されたボリュームタイプの場合は、replica_count パラメーターを渡す必要があります。レプリカ数が増える場合、ブリックの数はレプリカセットの数と同じである必要があります。

たとえば、gluster ボリューム 123 にブリックを追加するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

Copy to Clipboard

Toggle word wrap

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

<bricks>
  <brick>
    <server_id>111</server_id>
    <brick_dir>/export/data/brick3</brick_dir>
  </brick>
</bricks>

<bricks>
  <brick>
    <server_id>111</server_id>
    <brick_dir>/export/data/brick3</brick_dir>
  </brick>
</bricks>

Copy to Clipboard

Toggle word wrap

Expand

表6.287 パラメーターの概要
名前	型	方向	Summary
`bricks`	GlusterBrick[]	In/Out	ボリュームに追加するブリックのリスト
`replica_count`	Integer	In	ボリューム後の追加操作のレプリカ数。
`stripe_count`	Integer	In	追加後の操作のストライプ数。

6.101.3. list GET
リンクのコピー

gluster ボリュームのブリックをリスト表示します。

たとえば、gluster ボリューム 123 のブリックをリスト表示するには、以下のように要求を送信します。

GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

Copy to Clipboard

Toggle word wrap

以下のような出力を提供します。

<bricks>
  <brick id="234">
    <name>host1:/rhgs/data/brick1</name>
    <brick_dir>/rhgs/data/brick1</brick_dir>
    <server_id>111</server_id>
    <status>up</status>
  </brick>
  <brick id="233">
    <name>host2:/rhgs/data/brick1</name>
    <brick_dir>/rhgs/data/brick1</brick_dir>
    <server_id>222</server_id>
    <status>up</status>
  </brick>
</bricks>

<bricks>
  <brick id="234">
    <name>host1:/rhgs/data/brick1</name>
    <brick_dir>/rhgs/data/brick1</brick_dir>
    <server_id>111</server_id>
    <status>up</status>
  </brick>
  <brick id="233">
    <name>host2:/rhgs/data/brick1</name>
    <brick_dir>/rhgs/data/brick1</brick_dir>
    <server_id>222</server_id>
    <status>up</status>
  </brick>
</bricks>

Copy to Clipboard

Toggle word wrap

返されるリストの順序は、gluster ボリュームの作成時に提供されるブリックの順序に基づいています。

Expand

表6.288 パラメーターの概要
名前	型	方向	Summary
`bricks`	GlusterBrick[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すブリックの最大数を設定します。

6.101.3.1. follow
リンクのコピー

6.101.3.2. max
リンクのコピー

返すブリックの最大数を設定します。指定されていない場合は、すべてのブリックが返されます。

6.101.4. migrate POST
リンクのコピー

ブリックを削除する前にデータの移行を開始します。

ブリックの削除は 2 つのステップで、削除されるブリック上のデータが最初に残りのブリックに移行します。移行が完了すると、API remove を介してブリックの削除が確定されます。いずれの時点でも、stopmigrate をキャンセルするアクションを呼び出す必要があります。

たとえば、ID が 123 の gluster ボリュームからブリックを削除するには、次のリクエストを送信します。

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/migrate

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/migrate

Copy to Clipboard

Toggle word wrap

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

<action>
  <bricks>
    <brick>
      <name>host1:/rhgs/brick1</name>
    </brick>
  </bricks>
</action>

<action>
  <bricks>
    <brick>
      <name>host1:/rhgs/brick1</name>
    </brick>
  </bricks>
</action>

Copy to Clipboard

Toggle word wrap

移行プロセスは、ジョブを使用して API から返されたジョブ ID と、ステップを使用して job の step から追跡できます。

Expand

表6.289 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	移行を非同期的に実行するかどうかを指定します。
`bricks`	GlusterBrick[]	In	データ移行を開始する必要のあるブリックのリスト。

6.101.5. remove DELETE
リンクのコピー

gluster ボリュームからブリックを削除します。

データ損失なしでブリックを削除する場合は、最初に stopmigrate を使用してそれらのデータを削除してからそれらを削除する方法が推奨されます。削除前にイメージストリームで移行が呼び出されなかった場合、データ移行なしにブリックが削除され、データが失われる可能性があります。

たとえば、gluster ボリューム 123 からブリックを削除するには、以下のように要求を送信します。

DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks

Copy to Clipboard

Toggle word wrap

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

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>

Copy to Clipboard

Toggle word wrap

Expand

表6.290 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。
`bricks`	GlusterBrick[]	In	削除するブリックのリスト
`replica_count`	Integer	In	ボリューム後の追加操作のレプリカ数。

6.101.6. stopmigrate POST
リンクのコピー

削除のブリック操作に関するデータのブリックからの移行を停止します。

ユーザーがブリックの使用を継続したい場合に備えて、2 ステップのブリック削除プロセスの一部として開始されたデータ移行をキャンセルするには。削除用にマーク付けされていたブリックは、この操作の後に通常のブリックとして機能します。

たとえば、gluster ボリューム 123 のブリックからデータの移行を停止するには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/stopmigrate

POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/stopmigrate

Copy to Clipboard

Toggle word wrap

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

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>

Copy to Clipboard

Toggle word wrap

Expand

表6.291 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`bricks`	GlusterBrick[]	In	データ移行を停止する必要のあるブリックのリスト。

6.101.6.1. bricks
リンクのコピー

データ移行を停止する必要のあるブリックのリスト。このリストは、migrate のために渡された引数と一致する必要があります。

6.102. GlusterHook
リンクのコピー

Expand

表6.292 メソッドの概要
名前	Summary
`disable`	クラスターの全サーバーで Gluster フックを無効にすることにより、クラスターのサーバー間でフックのステータスの競合を解決します。
`enable`	クラスターの全サーバーで Gluster フックを無効にすることにより、クラスターのサーバー間でフックのステータスの競合を解決します。
`get`
`remove`	クラスターのすべてのサーバーからこの Gluster フックを削除し、これをデータベースから削除します。
`resolve`	解決のタイプに応じて、不足しているフックの競合を解決します。

6.102.1. disable POST
リンクのコピー

クラスターの全サーバーで Gluster フックを無効にすることにより、クラスターのサーバー間でフックのステータスの競合を解決します。これにより、データベースでフックのステータスが DISABLED に更新されました。

Expand

表6.293 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.102.2. enable POST
リンクのコピー

Expand

表6.294 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.102.3. get GET
リンクのコピー

Expand

表6.295 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hook`	GlusterHook	Out

6.102.3.1. follow
リンクのコピー

6.102.4. remove DELETE
リンクのコピー

クラスターのすべてのサーバーからこの Gluster フックを削除し、これをデータベースから削除します。

Expand

表6.296 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.102.5. resolve POST
リンクのコピー

解決のタイプに応じて、不足しているフックの競合を解決します。

ADD の場合は、フックがないすべてのサーバーに、エンジンデータベースに保存されているフックをコピーして解決します。エンジンは、フックがないすべてのサーバーのリストを維持します。

COPY の場合、フックが欠落しているすべてのサーバーにエンジンデータベースに保存されているフックをコピーして、フックの内容で競合を解決します。エンジンは、コンテンツが競合するサーバーのリストを維持します。ホスト ID がパラメーターとして渡される場合、サーバーのフックコンテンツがマスターとして使用され、クラスター内の他のサーバーにコピーすることができます。

Expand

表6.297 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`host`	ホスト	In
`resolution_type`	String	In

6.103. GlusterHooks
リンクのコピー

Expand

表6.298 メソッドの概要
名前	Summary
`list`	フックリストを返します。

6.103.1. list GET
リンクのコピー

フックリストを返します。

返されるフックリストの順序は保証されません。

Expand

表6.299 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hooks`	GlusterHook[]	Out
`max`	Integer	In	返すフックの最大数を設定します。

6.103.1.1. follow
リンクのコピー

6.103.1.2. max
リンクのコピー

返すフックの最大数を設定します。指定されていない場合は、すべてのフックが返されます。

6.104. GlusterVolume
リンクのコピー

このサービスは単一の gluster ボリュームを管理します。

Expand

表6.300 メソッドの概要
名前	Summary
`get`	gluster ボリュームの詳細を取得します。
`getprofilestatistics`	gluster ボリュームプロファイルの統計を取得します。
`rebalance`	gluster ボリュームをリバランスします。
`remove`	gluster ボリュームを削除します。
`resetalloptions`	gluster ボリュームに設定されたすべてのオプションをリセットします。
`resetoption`	gluster ボリュームで特定のオプションをリセットします。
`setoption`	gluster ボリュームに特定のオプションを設定します。
`start`	gluster ボリュームを起動します。
`startprofile`	gluster ボリュームのプロファイリングを開始します。
`stop`	gluster ボリュームを停止します。
`stopprofile`	gluster ボリュームのプロファイリングを停止します。
`stoprebalance`	gluster ボリュームのリバランスを停止します。

6.104.1. get GET
リンクのコピー

gluster ボリュームの詳細を取得します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームの詳細を取得するには、以下のように要求を送信します。

GET /ovirt-engine/api/clusters/456/glustervolumes/123

GET /ovirt-engine/api/clusters/456/glustervolumes/123

Copy to Clipboard

Toggle word wrap

この GET リクエストは以下の出力を返します。

<gluster_volume id="123">
 <name>data</name>
 <link href="/ovirt-engine/api/clusters/456/glustervolumes/123/glusterbricks" rel="glusterbricks"/>
 <disperse_count>0</disperse_count>
 <options>
   <option>
     <name>storage.owner-gid</name>
     <value>36</value>
   </option>
   <option>
     <name>performance.io-cache</name>
     <value>off</value>
   </option>
   <option>
     <name>cluster.data-self-heal-algorithm</name>
     <value>full</value>
   </option>
 </options>
 <redundancy_count>0</redundancy_count>
 <replica_count>3</replica_count>
 <status>up</status>
 <stripe_count>0</stripe_count>
 <transport_types>
   <transport_type>tcp</transport_type>
 </transport_types>
 <volume_type>replicate</volume_type>
 </gluster_volume>

<gluster_volume id="123">
 <name>data</name>
 <link href="/ovirt-engine/api/clusters/456/glustervolumes/123/glusterbricks" rel="glusterbricks"/>
 <disperse_count>0</disperse_count>
 <options>
   <option>
     <name>storage.owner-gid</name>
     <value>36</value>
   </option>
   <option>
     <name>performance.io-cache</name>
     <value>off</value>
   </option>
   <option>
     <name>cluster.data-self-heal-algorithm</name>
     <value>full</value>
   </option>
 </options>
 <redundancy_count>0</redundancy_count>
 <replica_count>3</replica_count>
 <status>up</status>
 <stripe_count>0</stripe_count>
 <transport_types>
   <transport_type>tcp</transport_type>
 </transport_types>
 <volume_type>replicate</volume_type>
 </gluster_volume>

Copy to Clipboard

Toggle word wrap

Expand

表6.301 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`volume`	GlusterVolume	Out	gluster ボリュームを表します。

6.104.1.1. follow
リンクのコピー

6.104.2. getprofilestatistics POST
リンクのコピー

gluster ボリュームプロファイルの統計を取得します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームのプロファイル統計を取得するには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics

POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics

Copy to Clipboard

Toggle word wrap

Expand

表6.302 パラメーターの概要
名前	型	方向	Summary
`details`	GlusterVolumeProfileDetails	Out	アクションから返される Gluster ボリュームのプロファイリング情報。

6.104.3. rebalance POST
リンクのコピー

gluster ボリュームをリバランスします。

gluster ボリュームのリバランスは、すべてのブリックにデータを均等に分散するのに役立ちます。(データの移行なし) gluster ボリュームを拡張または縮小した後、ブリック間でデータのリバランスを行う必要があります。複製されていないボリュームでは、リバランス操作を実行するために、すべてのブリックをオンラインにする必要があります。複製されたボリュームでは、レプリカ内の少なくとも 1 つのブリックがオンラインである必要があります。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームをリバランスするには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance

POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance

Copy to Clipboard

Toggle word wrap

Expand

表6.303 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リバランスを非同期的に実行するかどうかを指定します。
`fix_layout`	ブール値	In	true に設定すると、リバランスによってレイアウトが修正され、ボリュームに追加された新規データがすべてのホストに分散されます。
`force`	ブール値	In	リバランスを強制的に起動するかどうかを示します。

6.104.3.1. fix_layout
リンクのコピー

true に設定すると、リバランスによってレイアウトが修正され、ボリュームに追加された新規データがすべてのホストに分散されます。ただし、既存のデータは移行/リバランスされません。デフォルトは false です。

6.104.3.2. force
リンクのコピー

リバランスを強制的に起動するかどうかを示します。rebalance コマンドは、古いクライアントがクラスターに接続されている場合でも、force オプションを使用して実行できます。ただし、これにより、データが失われる可能性があります。デフォルトは false です。

6.104.4. remove DELETE
リンクのコピー

gluster ボリュームを削除します。

たとえば、クラスター 456 で識別子 123 のボリュームを削除するには、以下のように要求を送信します。

DELETE /ovirt-engine/api/clusters/456/glustervolumes/123

DELETE /ovirt-engine/api/clusters/456/glustervolumes/123

Copy to Clipboard

Toggle word wrap

Expand

表6.304 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.104.5. resetalloptions POST
リンクのコピー

gluster ボリュームに設定されたすべてのオプションをリセットします。

たとえば、クラスター 456 で識別子 123 を使用して gluster ボリューム内のすべてのオプションをリセットするには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions

POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions

Copy to Clipboard

Toggle word wrap

Expand

表6.305 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リセットを非同期で実行する必要があるかどうかを示します。

6.104.6. resetoption POST
リンクのコピー

gluster ボリュームで特定のオプションをリセットします。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームで特定の option1 をリセットするには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoption

POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoption

Copy to Clipboard

Toggle word wrap

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

<action>
 <option name="option1"/>
</action>

<action>
 <option name="option1"/>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.306 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リセットを非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In
`option`	オプション	In	リセットするオプション。

6.104.7. setoption POST
リンクのコピー

gluster ボリュームに特定のオプションを設定します。

たとえば、クラスター 456 で識別子 123 で gluster ボリュームに option1 の値 value1 を設定するには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoption

POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoption

Copy to Clipboard

Toggle word wrap

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

<action>
 <option name="option1" value="value1"/>
</action>

<action>
 <option name="option1" value="value1"/>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.307 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`option`	オプション	In	設定するオプション。

6.104.8. start POST
リンクのコピー

gluster ボリュームを起動します。

Gluster ボリュームは、データの読み取り/書き込みを開始する必要があります。たとえば、クラスター 456 で識別子 123 で gluster ボリュームを起動するには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/start

POST /ovirt-engine/api/clusters/456/glustervolumes/123/start

Copy to Clipboard

Toggle word wrap

Expand

表6.308 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In	ボリュームが強制的に起動するかどうかを示します。

6.104.8.1. force
リンクのコピー

ボリュームが強制的に起動するかどうかを示します。gluster ボリュームがすでに開始されているが、いくつか/すべてのブリックがダウンしている場合は、強制開始を使用してすべてのブリックを起動できます。デフォルトは false です。

6.104.9. startprofile POST
リンクのコピー

gluster ボリュームのプロファイリングを開始します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームのプロファイリングを開始するには、以下のような要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile

POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile

Copy to Clipboard

Toggle word wrap

Expand

表6.309 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.104.10. stop POST
リンクのコピー

gluster ボリュームを停止します。

ボリュームを停止すると、そのデータにはアクセスできなくなります。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームを停止するには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop

Copy to Clipboard

Toggle word wrap

Expand

表6.310 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In

6.104.11. stopprofile POST
リンクのコピー

gluster ボリュームのプロファイリングを停止します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームのプロファイリングを停止するには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile

Copy to Clipboard

Toggle word wrap

Expand

表6.311 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.104.12. stoprebalance POST
リンクのコピー

gluster ボリュームのリバランスを停止します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームの再調整を停止するには、以下のように要求を送信します。

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance

Copy to Clipboard

Toggle word wrap

Expand

表6.312 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.105. GlusterVolumes
リンクのコピー

このサービスは、クラスターで利用可能な gluster ボリュームのコレクションを管理します。

Expand

表6.313 メソッドの概要
名前	Summary
`add`	新しい gluster ボリュームを作成します。
`list`	クラスター内のすべての gluster ボリュームをリスト表示します。

6.105.1. add POST
リンクのコピー

新しい gluster ボリュームを作成します。

ボリュームは、volume パラメーターのプロパティーに基づいて作成されます。プロパティー name、volume_type、および bricks が必要です。

たとえば、myvolume という名前のボリュームをクラスター 123 に追加するには、以下の要求を送信します。

POST /ovirt-engine/api/clusters/123/glustervolumes

POST /ovirt-engine/api/clusters/123/glustervolumes

Copy to Clipboard

Toggle word wrap

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

<gluster_volume>
  <name>myvolume</name>
  <volume_type>replicate</volume_type>
  <replica_count>3</replica_count>
  <bricks>
    <brick>
      <server_id>server1</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
    <brick>
      <server_id>server2</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
    <brick>
      <server_id>server3</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
  <bricks>
</gluster_volume>

<gluster_volume>
  <name>myvolume</name>
  <volume_type>replicate</volume_type>
  <replica_count>3</replica_count>
  <bricks>
    <brick>
      <server_id>server1</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
    <brick>
      <server_id>server2</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
    <brick>
      <server_id>server3</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
  <bricks>
</gluster_volume>

Copy to Clipboard

Toggle word wrap

Expand

表6.314 パラメーターの概要
名前	型	方向	Summary
`volume`	GlusterVolume	In/Out	ボリュームを作成する gluster ボリュームの定義が入力として渡され、新規に作成されるボリュームが返されます。

6.105.2. list GET
リンクのコピー

クラスター内のすべての gluster ボリュームをリスト表示します。

たとえば、クラスター 456 のすべての Gluster ボリュームをリスト表示するには、以下のように要求を送信します。

GET /ovirt-engine/api/clusters/456/glustervolumes

GET /ovirt-engine/api/clusters/456/glustervolumes

Copy to Clipboard

Toggle word wrap

返されるボリュームリストの順序は保証されません。

Expand

表6.315 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すボリュームの最大数を設定します。
`search`	String	In	返されたボリュームを制限するために使用されるクエリー文字列です。
`volumes`	GlusterVolume[]	Out

6.105.2.1. case_sensitive
リンクのコピー

6.105.2.2. follow
リンクのコピー

6.105.2.3. max
リンクのコピー

返すボリュームの最大数を設定します。指定されていない場合は、すべてのボリュームが返されます。

6.106. グループ
リンクのコピー

ユーザーのグループを管理します。このサービスを使用して、グループの詳細を取得したり、グループを削除します。新規グループを追加するには、グループのコレクションを管理する service を使用します。

Expand

表6.316 メソッドの概要
名前	Summary
`get`	システムグループ情報を取得します。
`remove`	システムグループを削除します。

6.106.1. get GET
リンクのコピー

システムグループ情報を取得します。

使用方法:

GET /ovirt-engine/api/groups/123

GET /ovirt-engine/api/groups/123

Copy to Clipboard

Toggle word wrap

グループ情報を返します。

<group href="/ovirt-engine/api/groups/123" id="123">
  <name>mygroup</name>
  <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
  <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
  <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
  <namespace>DC=example,DC=com</namespace>
  <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
    <name>myextension-authz</name>
  </domain>
</group>

<group href="/ovirt-engine/api/groups/123" id="123">
  <name>mygroup</name>
  <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
  <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
  <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
  <namespace>DC=example,DC=com</namespace>
  <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
    <name>myextension-authz</name>
  </domain>
</group>

Copy to Clipboard

Toggle word wrap

Expand

表6.317 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`get`	グループ	Out	システムグループ。

6.106.1.1. follow
リンクのコピー

6.106.2. remove DELETE
リンクのコピー

システムグループを削除します。

使用方法:

DELETE /ovirt-engine/api/groups/123

DELETE /ovirt-engine/api/groups/123

Copy to Clipboard

Toggle word wrap

Expand

表6.318 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.107. グループ
リンクのコピー

ユーザーのグループのコレクションを管理します。

Expand

表6.319 メソッドの概要
名前	Summary
`add`	ディレクトリーサービスからグループを追加します。
`list`	システム内のすべてのグループをリスト表示します。

6.107.1. add POST
リンクのコピー

ディレクトリーサービスからグループを追加します。ドメイン名は、認証プロバイダーの名前であることに注意してください。

たとえば、internal-authz 認証プロバイダーから Developers グループを追加するには、以下のような要求を送信します。

POST /ovirt-engine/api/groups

POST /ovirt-engine/api/groups

Copy to Clipboard

Toggle word wrap

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

<group>
  <name>Developers</name>
  <domain>
    <name>internal-authz</name>
  </domain>
</group>

<group>
  <name>Developers</name>
  <domain>
    <name>internal-authz</name>
  </domain>
</group>

Copy to Clipboard

Toggle word wrap

Expand

表6.320 パラメーターの概要
名前	型	方向	Summary
`group`	グループ	In/Out	追加するグループ。

6.107.2. list GET
リンクのコピー

システム内のすべてのグループをリスト表示します。

使用方法:

GET /ovirt-engine/api/groups

GET /ovirt-engine/api/groups

Copy to Clipboard

Toggle word wrap

グループのリストを返します。

<groups>
  <group href="/ovirt-engine/api/groups/123" id="123">
    <name>mygroup</name>
    <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
    <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
    <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
    <namespace>DC=example,DC=com</namespace>
    <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
      <name>myextension-authz</name>
    </domain>
  </group>
  ...
</groups>

<groups>
  <group href="/ovirt-engine/api/groups/123" id="123">
    <name>mygroup</name>
    <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
    <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
    <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
    <namespace>DC=example,DC=com</namespace>
    <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
      <name>myextension-authz</name>
    </domain>
  </group>
  ...
</groups>

Copy to Clipboard

Toggle word wrap

返されたグループリストの順序は保証されません。

Expand

表6.321 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`グループ`	Group[]	Out	グループのリスト。
`max`	Integer	In	返すグループの最大数を設定します。
`search`	String	In	返されるグループを制限するために使用されるクエリー文字列。

6.107.2.1. case_sensitive
リンクのコピー

6.107.2.2. follow
リンクのコピー

6.107.2.3. max
リンクのコピー

返すグループの最大数を設定します。指定のない場合は、すべてのグループが返されます。

6.108. ホスト
リンクのコピー

ホストを管理するサービス

Expand

表6.322 メソッドの概要
名前	Summary
`activate`	仮想マシンを実行するなど、使用するホストをアクティベートします。
`approve`	仮想化環境で使用するために事前にインストールされたハイパーバイザーホストを承認します。
`commitnetconfig`	ネットワーク設定を正常としてマークし、ホスト内にその設定を持続させます。
`copyhostnetworks`	指定したホストのネットワーク設定を現在のホストにコピーします。
`deactivate`	ホストを無効にして、メンテナンスタスクを実行します。
`discoveriscsi`	イニシエーターの詳細を使用して、ホスト上の iSCSI ターゲットを検出します。
`enrollcertificate`	ホストの証明書を登録します。
`fence`	ホストの電源管理デバイスを制御します。
`forceselectspm`	ホストを Storage Pool Manager (SPM) として手動で設定します。
`get`	ホストの詳細を取得します。
`install`	最新バージョンの VDSM と関連ソフトウェアをホストにインストールします。
`iscsidiscover`	このメソッドは、Engine バージョン 4 以降非推奨となりました。
`iscsilogin`	ターゲットの詳細を使用して、ホストの iSCSI ターゲットにログインします。
`refresh`	ホストデバイスと機能を更新します。
`remove`	システムからホストを削除します。
`setupnetworks`	この方法は、ホストのネットワークインターフェイスの設定を変更するために使用されます。
`syncallnetworks`	ホスト上の全ネットワークを同期するには、以下のような要求を送信します。 [source] ---- POST /ovirt-engine/api/hosts/123/syncallnetworks ---- リクエスト本文は以下のようになります。 [source,xml] ---- <action/> ----
`unregisteredstoragedomainsdiscover`	設定にインポートする候補であるブロックストレージドメインを検出します。
`update`	ホストのプロパティーを更新します。
`upgrade`	ホストで VDSM および選択したソフトウェアをアップグレードします。
`upgradecheck`	ホストにアップグレードが利用可能であるかどうかを確認します。

6.108.1. activate POST
リンクのコピー

仮想マシンを実行するなど、使用するホストをアクティベートします。

Expand

表6.323 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクティベーションを非同期で実行する必要があるかどうかを示します。

6.108.2. approve POST
リンクのコピー

仮想化環境で使用するために事前にインストールされたハイパーバイザーホストを承認します。

このアクションは、このホストのターゲットクラスターを定義するためのオプションのクラスター要素も受け入れます。

Expand

表6.324 パラメーターの概要
名前	型	方向	Summary
`activate`	ブール値	In	'true' に設定すると、このホストは承認の完了後にアクティベートされます。
`async`	ブール値	In	承認を非同期的に実行するかどうかを指定します。
`cluster`	クラスター	In	ホストが承認後に追加されるクラスター。
`host`	ホスト	In	承認するホスト。
`reboot`	ブール値	In	インストールに成功した後にホストを再起動するかどうかを示します。

6.108.2.1. activate
リンクのコピー

'true' に設定すると、このホストは承認の完了後にアクティベートされます。'false' に設定すると、ホストは承認後も 'maintenance' ステータスのままになります。このパラメーターがない場合は 'true' と解釈されます。これは、望ましいデフォルトの動作が承認後にホストをアクティブ化するからです。

6.108.2.2. reboot
リンクのコピー

インストールに成功した後にホストを再起動するかどうかを示します。デフォルト値は true です。

6.108.3. commitnetconfig POST
リンクのコピー

ネットワーク設定を正常としてマークし、ホスト内にその設定を持続させます。

API ユーザーは、ネットワーク設定をコミットして、ホストネットワークインターフェイスのアタッチメントまたはデタッチメントを永続化するか、ボンディングされたインターフェイスの作成と削除を永続化します。

重要

ネットワーク設定は、設定の変更によってホスト接続が失われないことをエンジンが確認した後にのみ、コミットされます。ホストの接続が失われた場合、ホストを再起動する必要があり、自動的に以前のネットワーク設定に戻ります。

たとえば、ID が 123 のホストのネットワーク設定をコミットするには、次のようなリクエストを送信します。

POST /ovirt-engine/api/hosts/123/commitnetconfig

POST /ovirt-engine/api/hosts/123/commitnetconfig

Copy to Clipboard

Toggle word wrap

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

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

重要

Red Hat Virtualization Manager 4.3 以降、setupnetworks リクエストで commit_on_success を指定することもできます。この場合、セットアップが完了し、{hypervisor-name} と Red Hat Virtualization Manager 間の接続が再確立され、個別の commitnetconfig リクエストを待つことなく、新しい設定が {hypervisor-name} に自動的に保存されます。

Expand

表6.325 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.108.4. copyhostnetworks POST
リンクのコピー

指定したホストのネットワーク設定を現在のホストにコピーします。

重要

ソースホストに存在しないネットワークアタッチメントは、コピー操作によってターゲットホストから消去されます。

別のホストからネットワークをコピーするには、次のようなリクエストを送信します。

POST /ovirt-engine/api/hosts/123/copyhostnetworks

POST /ovirt-engine/api/hosts/123/copyhostnetworks

Copy to Clipboard

Toggle word wrap

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

<action>
   <source_host id="456"/>
</action>

<action>
   <source_host id="456"/>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.326 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`source_host`	ホスト	In	ネットワークのコピー元となるホスト。

6.108.5. deactivate POST
リンクのコピー

ホストを無効にして、メンテナンスタスクを実行します。

Expand

表6.327 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	非アクティブ化を非同期で実行する必要があるかどうかを示します。
`reason`	String	In
`stop_gluster_service`	ブール値	In	ホストの非アクティブ化の一環として gluster サービスを停止する必要があるかどうかを示します。

6.108.5.1. stop_gluster_service
リンクのコピー

ホストの非アクティブ化の一環として gluster サービスを停止する必要があるかどうかを示します。gluster ホストのメンテナンス操作中に使用できます。この変数のデフォルト値は false です。

6.108.6. discoveriscsi POST
リンクのコピー

イニシエーターの詳細を使用して、ホスト上の iSCSI ターゲットを検出します。検出されたデータを含む IscsiDetails オブジェクトのリストを返します。

たとえば、myiscsi.example.com で利用可能な iSCSI ターゲットをホスト 123 から検出するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/hosts/123/discoveriscsi

POST /ovirt-engine/api/hosts/123/discoveriscsi

Copy to Clipboard

Toggle word wrap

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

<action>
  <iscsi>
    <address>myiscsi.example.com</address>
  </iscsi>
</action>

<action>
  <iscsi>
    <address>myiscsi.example.com</address>
  </iscsi>
</action>

Copy to Clipboard

Toggle word wrap

結果は以下のようになります。

<discovered_targets>
  <iscsi_details>
    <address>10.35.1.72</address>
    <port>3260</port>
    <portal>10.35.1.72:3260,1</portal>
    <target>iqn.2015-08.com.tgt:444</target>
  </iscsi_details>
</discovered_targets>

<discovered_targets>
  <iscsi_details>
    <address>10.35.1.72</address>
    <port>3260</port>
    <portal>10.35.1.72:3260,1</portal>
    <target>iqn.2015-08.com.tgt:444</target>
  </iscsi_details>
</discovered_targets>

Copy to Clipboard

Toggle word wrap

重要

このメソッドを使用して、iSCSI ターゲットを検出する場合には、FQDN または IP アドレスを使用できますが、REST API メソッドを使用してログインするには、検出された iSCSI ターゲットの詳細を使用する必要があります。

Expand

表6.328 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	検出を非同期で実行する必要があるかどうかを示します。
`discovered_targets`	IscsiDetails[]	Out	すべての接続情報を含む検出されたターゲット。
`iscsi`	IscsiDetails	In	ターゲット iSCSI デバイス。

6.108.7. enrollcertificate POST
リンクのコピー

ホストの証明書を登録します。有効期限が近づいている、またはすでに有効期限が切れているという警告が表示された場合に便利です。

Expand

表6.329 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	登録を非同期で実行する必要があるかどうかを示します。

6.108.8. fence POST
リンクのコピー

ホストの電源管理デバイスを制御します。

たとえば、ホストを起動するとします。これは、以下の方法で実行できます。

#!/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 '
<action>
  <fence_type>start</fence_type>
</action>
' \
"${url}/hosts/123/fence"

#!/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 '
<action>
  <fence_type>start</fence_type>
</action>
' \
"${url}/hosts/123/fence"

Copy to Clipboard

Toggle word wrap

Expand

表6.330 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	フェンシングを非同期で実行する必要があるかどうかを示します。
`fence_type`	String	In
`maintenance_after_restart`	ブール値	In	再起動後にホストをメンテナンスする必要があるかどうかを示します。
`power_management`	PowerManagement	Out

6.108.9. forceselectspm POST
リンクのコピー

ホストを Storage Pool Manager (SPM) として手動で設定します。

POST /ovirt-engine/api/hosts/123/forceselectspm

POST /ovirt-engine/api/hosts/123/forceselectspm

Copy to Clipboard

Toggle word wrap

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

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.331 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.108.10. get GET
リンクのコピー

ホストの詳細を取得します。

GET /ovirt-engine/api/hosts/123

GET /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

Expand

表6.332 パラメーターの概要
名前	型	方向	Summary
`all_content`	ブール値	In	ホストのすべての属性を応答に含めるかどうかを指定します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`host`	ホスト	Out	クエリーされたホスト。

6.108.10.1. all_content
リンクのコピー

ホストのすべての属性を応答に含めるかどうかを指定します。

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

hosted_engine

たとえば、ホスト '123' の完全な表現を取得するには、以下を実行します。

GET /ovirt-engine/api/hosts/123?all_content=true

GET /ovirt-engine/api/hosts/123?all_content=true

Copy to Clipboard

Toggle word wrap

注記

これらの属性は、取得後にパフォーマンスに影響を及ぼすため、デフォルトでは含まれていません。これらはめったに使用されず、データベースへの追加のクエリーを必要とします。このパラメーターは、特に必要な場合にのみ注意して使用してください。

6.108.10.2. follow
リンクのコピー

6.108.11. install POST
リンクのコピー

最新バージョンの VDSM と関連ソフトウェアをホストにインストールします。

このアクションは、ホストをエンジンに追加するときに実行されるホスト上のすべての設定ステップ (kdump 設定、ホスト型エンジンのデプロイ、カーネルオプションの変更など) も実行します。

ホストタイプは、アクションの追加パラメーターを定義します。

curl と JSON を使用してホストをインストールする例、プレーン:

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"

Copy to Clipboard

Toggle word wrap

ホスト型エンジンコンポーネントで curl と JSON を使用してホストをインストールする例:

curl \
curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
"deploy_hosted_engine" : "true"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"

curl \
curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
"deploy_hosted_engine" : "true"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"

Copy to Clipboard

Toggle word wrap

重要

エンジンのバージョン 4.1.2 以降、ホストが再インストールされると、デフォルトでホストファイアウォールの定義をオーバーライドするようになりました。

Expand

表6.333 パラメーターの概要
名前	型	方向	Summary
`activate`	ブール値	In	'true' に設定すると、このホストはインストールの完了後にアクティブになります。
`async`	ブール値	In	インストールを非同期で実行する必要があるかどうかを示します。
`deploy_hosted_engine`	ブール値	In	`true` に設定すると、このホストは自己ホスト型エンジンコンポーネントもデプロイします。
`host`	ホスト	In	`override_iptables` プロパティーは、ファイアウォール設定をデフォルトの設定に置き換える必要があるかどうかを示すために使用されます。
`image`	String	In	{hypervisor-name} をインストールする場合、ISO イメージファイルが必要です。
`reboot`	ブール値	In	インストールに成功した後にホストを再起動するかどうかを示します。
`root_password`	String	In	SSH 経由でホストに接続するために使用される `root` ユーザーのパスワード。
`ssh`	Ssh	In	ホストへの接続に使用される SSH の詳細。
`undeploy_hosted_engine`	ブール値	In	`true` に設定すると、このホストは自己ホスト型エンジンコンポーネントをアンデプロイし、このホストは高可用性クラスターの一部として機能しなくなります。

6.108.11.1. activate
リンクのコピー

'true' に設定すると、このホストはインストールの完了後にアクティブになります。'false' に設定すると、ホストはインストール後も 'maintenance' ステータスのままになります。このパラメーターがない場合は 'true' と解釈されます。これは、望ましいデフォルトの動作がインストール後にホストをアクティブ化するからです。

6.108.11.2. deploy_hosted_engine
リンクのコピー

true に設定すると、このホストは自己ホスト型エンジンコンポーネントもデプロイします。欠落している値は true、つまりデプロイとして扱われます。このパラメーターを省略すると、false を意味し、セルフホスト型エンジン領域での操作は一切行われません。

6.108.11.3. reboot
リンクのコピー

インストールに成功した後にホストを再起動するかどうかを示します。デフォルト値は true です。

6.108.11.4. undeploy_hosted_engine
リンクのコピー

true に設定すると、このホストは自己ホスト型エンジンコンポーネントをアンデプロイし、このホストは高可用性クラスターの一部として機能しなくなります。欠落している値は true、つまりアンデプロイとして扱われます。このパラメーターを省略すると、false を意味し、セルフホスト型エンジン領域での操作は一切行われません。

6.108.12. iscsidiscover POST
リンクのコピー

このメソッドは、Engine バージョン 4.4.6 以降非推奨となりました。代わりに DiscoverIscsi を使用する必要があります。

イニシエーターの詳細を使用して、ホスト上の iSCSI ターゲットを検出します。検出されたデータを含む文字列の配列を返します。

たとえば、myiscsi.example.com で利用可能な iSCSI ターゲットをホスト 123 から検出するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/hosts/123/iscsidiscover

POST /ovirt-engine/api/hosts/123/iscsidiscover

Copy to Clipboard

Toggle word wrap

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

<action>
  <iscsi>
    <address>myiscsi.example.com</address>
  </iscsi>
</action>

<action>
  <iscsi>
    <address>myiscsi.example.com</address>
  </iscsi>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.334 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	検出を非同期で実行する必要があるかどうかを示します。
`iscsi`	IscsiDetails	In	ターゲット iSCSI デバイス。
`iscsi_targets`	String[]	Out	iSCSI ターゲット。

6.108.12.1. iscsi_targets
リンクのコピー

iSCSI ターゲット。*

6.108.13. iscsilogin POST
リンクのコピー

ターゲットの詳細を使用して、ホストの iSCSI ターゲットにログインします。

重要

このメソッドを使用してログインする場合は、discoveriscsi メソッドで検出された iSCSI ターゲットの詳細を使用する必要があります。

Expand

表6.335 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	ログインを非同期で実行する必要があるかどうかを示します。
`iscsi`	IscsiDetails	In	ターゲット iSCSI デバイス。

6.108.14. refresh POST
リンクのコピー

ホストデバイスと機能を更新します。

Expand

表6.336 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リフレッシュを非同期で実行する必要があるかどうかを示します。

6.108.15. remove DELETE
リンクのコピー

システムからホストを削除します。

#!/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 DELETE \
--header "Version: 4" \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc"

#!/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 DELETE \
--header "Version: 4" \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc"

Copy to Clipboard

Toggle word wrap

Expand

表6.337 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。
`force`	ブール値	In	ホストが応答しない場合、またはホストが Gluster Storage クラスターの一部であり、ボリュームブリックがある場合でも、ホストを削除する必要があることを示します。

6.108.16. setupnetworks POST
リンクのコピー

この方法は、ホストのネットワークインターフェイスの設定を変更するために使用されます。

たとえば、3 つのネットワークインターフェイス eth0、eth1、および eth2 を持つホストがあり、eth0 と eth1 を使用して新しいボンディングを設定し、その上に VLAN を配置するとします。簡単なシェルスクリプトと curl コマンドライン HTTP クライアントを使用すると、以下のように実行できます。

#!/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 '
<action>
  <modified_bonds>
    <host_nic>
      <name>bond0</name>
      <bonding>
        <options>
          <option>
            <name>mode</name>
            <value>4</value>
          </option>
          <option>
            <name>miimon</name>
            <value>100</value>
          </option>
        </options>
        <slaves>
          <host_nic>
            <name>eth1</name>
          </host_nic>
          <host_nic>
            <name>eth2</name>
          </host_nic>
        </slaves>
      </bonding>
    </host_nic>
  </modified_bonds>
  <modified_network_attachments>
    <network_attachment>
      <network>
        <name>myvlan</name>
      </network>
      <host_nic>
        <name>bond0</name>
      </host_nic>
      <ip_address_assignments>
        <ip_address_assignment>
          <assignment_method>static</assignment_method>
          <ip>
            <address>192.168.122.10</address>
            <netmask>255.255.255.0</netmask>
          </ip>
        </ip_address_assignment>
      </ip_address_assignments>
      <dns_resolver_configuration>
        <name_servers>
          <name_server>1.1.1.1</name_server>
          <name_server>2.2.2.2</name_server>
        </name_servers>
      </dns_resolver_configuration>
    </network_attachment>
  </modified_network_attachments>
 </action>
' \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc/setupnetworks"

#!/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 '
<action>
  <modified_bonds>
    <host_nic>
      <name>bond0</name>
      <bonding>
        <options>
          <option>
            <name>mode</name>
            <value>4</value>
          </option>
          <option>
            <name>miimon</name>
            <value>100</value>
          </option>
        </options>
        <slaves>
          <host_nic>
            <name>eth1</name>
          </host_nic>
          <host_nic>
            <name>eth2</name>
          </host_nic>
        </slaves>
      </bonding>
    </host_nic>
  </modified_bonds>
  <modified_network_attachments>
    <network_attachment>
      <network>
        <name>myvlan</name>
      </network>
      <host_nic>
        <name>bond0</name>
      </host_nic>
      <ip_address_assignments>
        <ip_address_assignment>
          <assignment_method>static</assignment_method>
          <ip>
            <address>192.168.122.10</address>
            <netmask>255.255.255.0</netmask>
          </ip>
        </ip_address_assignment>
      </ip_address_assignments>
      <dns_resolver_configuration>
        <name_servers>
          <name_server>1.1.1.1</name_server>
          <name_server>2.2.2.2</name_server>
        </name_servers>
      </dns_resolver_configuration>
    </network_attachment>
  </modified_network_attachments>
 </action>
' \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc/setupnetworks"

Copy to Clipboard

Toggle word wrap

注記

これは、API のバージョン 4 で有効です。以前のバージョンでは、一部の要素は XML 要素ではなく XML 属性として表されていました。特に、options と ip 要素は次のように表されました。

<options name="mode" value="4"/>
<options name="miimon" value="100"/>
<ip address="192.168.122.10" netmask="255.255.255.0"/>

<options name="mode" value="4"/>
<options name="miimon" value="100"/>
<ip address="192.168.122.10" netmask="255.255.255.0"/>

Copy to Clipboard

Toggle word wrap

次のコードで Python SDK を使用しても、同じことができます。

# Find the service that manages the collection of hosts:
hosts_service = connection.system_service().hosts_service()

# Find the host:
host = hosts_service.list(search='name=myhost')[0]

# Find the service that manages the host:
host_service = hosts_service.host_service(host.id)

# Configure the network adding a bond with two slaves and attaching it to a
network with an static IP address:
host_service.setup_networks(
    modified_bonds=[
        types.HostNic(
            name='bond0',
            bonding=types.Bonding(
                options=[
                    types.Option(
                        name='mode',
                        value='4',
                    ),
                    types.Option(
                        name='miimon',
                        value='100',
                    ),
                ],
                slaves=[
                    types.HostNic(
                        name='eth1',
                    ),
                    types.HostNic(
                        name='eth2',
                    ),
                ],
            ),
        ),
    ],
    modified_network_attachments=[
        types.NetworkAttachment(
            network=types.Network(
                name='myvlan',
            ),
            host_nic=types.HostNic(
                name='bond0',
            ),
            ip_address_assignments=[
                types.IpAddressAssignment(
                    assignment_method=types.BootProtocol.STATIC,
                    ip=types.Ip(
                        address='192.168.122.10',
                        netmask='255.255.255.0',
                    ),
                ),
            ],
            dns_resolver_configuration=types.DnsResolverConfiguration(
                name_servers=[
                    '1.1.1.1',
                    '2.2.2.2',
                ],
            ),
        ),
    ],
)

# After modifying the network configuration it is very important to make it
persistent:
host_service.commit_net_config()

# Find the service that manages the collection of hosts:
hosts_service = connection.system_service().hosts_service()

# Find the host:
host = hosts_service.list(search='name=myhost')[0]

# Find the service that manages the host:
host_service = hosts_service.host_service(host.id)

# Configure the network adding a bond with two slaves and attaching it to a
# network with an static IP address:
host_service.setup_networks(
    modified_bonds=[
        types.HostNic(
            name='bond0',
            bonding=types.Bonding(
                options=[
                    types.Option(
                        name='mode',
                        value='4',
                    ),
                    types.Option(
                        name='miimon',
                        value='100',
                    ),
                ],
                slaves=[
                    types.HostNic(
                        name='eth1',
                    ),
                    types.HostNic(
                        name='eth2',
                    ),
                ],
            ),
        ),
    ],
    modified_network_attachments=[
        types.NetworkAttachment(
            network=types.Network(
                name='myvlan',
            ),
            host_nic=types.HostNic(
                name='bond0',
            ),
            ip_address_assignments=[
                types.IpAddressAssignment(
                    assignment_method=types.BootProtocol.STATIC,
                    ip=types.Ip(
                        address='192.168.122.10',
                        netmask='255.255.255.0',
                    ),
                ),
            ],
            dns_resolver_configuration=types.DnsResolverConfiguration(
                name_servers=[
                    '1.1.1.1',
                    '2.2.2.2',
                ],
            ),
        ),
    ],
)

# After modifying the network configuration it is very important to make it
# persistent:
host_service.commit_net_config()

Copy to Clipboard

Toggle word wrap

重要

ネットワーク設定がホストに保存されていること、およびホストの再起動時に適用されることを確認するには、commitnetconfig を呼び出すことを忘れないでください。

重要

Expand

表6.338 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`check_connectivity`	ブール値	In
`commit_on_success`	ブール値	In	セットアップが完了し、{hypervisor-name} と Red Hat Virtualization Manager 間の接続が再確立され、個別の commitnetconfig リクエストを待つことなく、設定を {hypervisor-name} に自動的に保存するかどうかを指定します。
`connectivity_timeout`	Integer	In
`modified_bonds`	HostNic[]	In
`modified_labels`	NetworkLabel[]	In
`modified_network_attachments`	NetworkAttachment[]	In
`removed_bonds`	HostNic[]	In
`removed_labels`	NetworkLabel[]	In
`removed_network_attachments`	NetworkAttachment[]	In
`synchronized_network_attachments`	NetworkAttachment[]	In	同期されるネットワーク接続のリスト。

6.108.16.1. commit_on_success
リンクのコピー

セットアップが完了し、{hypervisor-name} と Red Hat Virtualization Manager 間の接続が再確立され、個別の commitnetconfig リクエストを待つことなく、設定を {hypervisor-name} に自動的に保存するかどうかを指定します。デフォルト値は false です。これは、設定が自動的に保存されないことを意味します。

6.108.17. syncallnetworks POST
リンクのコピー

ホスト上の全ネットワークを同期するには、以下のような要求を送信します。

POST /ovirt-engine/api/hosts/123/syncallnetworks

POST /ovirt-engine/api/hosts/123/syncallnetworks

Copy to Clipboard

Toggle word wrap

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

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.339 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.108.18. unregisteredstoragedomainsdiscover POST
リンクのコピー

設定にインポートする候補であるブロックストレージドメインを検出します。FCP の場合は、引数は必要ありません。

Expand

表6.340 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	検出を非同期で実行する必要があるかどうかを示します。
`iscsi`	IscsiDetails	In
`storage_domains`	StorageDomain[]	Out

6.108.19. update PUT
リンクのコピー

ホストのプロパティーを更新します。

たとえば、ホストのカーネルコマンドラインを更新するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/hosts/123

PUT /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

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

<host>
  <os>
    <custom_kernel_cmdline>vfio_iommu_type1.allow_unsafe_interrupts=1</custom_kernel_cmdline>
  </os>
</host>

<host>
  <os>
    <custom_kernel_cmdline>vfio_iommu_type1.allow_unsafe_interrupts=1</custom_kernel_cmdline>
  </os>
</host>

Copy to Clipboard

Toggle word wrap

Expand

表6.341 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`host`	ホスト	In/Out

6.108.20. upgrade POST
リンクのコピー

ホストで VDSM および選択したソフトウェアをアップグレードします。

Expand

表6.342 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アップグレードを非同期で実行する必要があるかどうかを示します。
`image`	String	In	Vintage Node はサポートされなくなり、非推奨になったため、このプロパティーは関連しなくなりました。
`reboot`	ブール値	In	アップグレード後にホストを再起動する必要があるかどうかを示します。
`timeout`	Integer	In	アップグレードのタイムアウト。

6.108.20.1. reboot
リンクのコピー

アップグレード後にホストを再起動する必要があるかどうかを示します。デフォルトでは、ホストは再起動されます。

注記

{hypervisor-name} の場合、このパラメーターは無視されます。{hypervisor-name} は、アップグレード後に常に再起動されます。

6.108.20.2. timeout
リンクのコピー

アップグレードのタイムアウト。

アップグレードが完了するまでの最大待機時間 (分単位)。デフォルト値は ANSIBLE_PLAYBOOK_EXEC_DEFAULT_TIMEOUT 設定オプションで指定します。

6.108.21. upgradecheck POST
リンクのコピー

ホストにアップグレードが利用可能であるかどうかを確認します。利用可能なアップグレードがある場合は、管理ポータルのホストステータスアイコンの横にアイコンが表示されます。また、アップグレードの可否を示す監査ログメッセージも追加されます。アップグレードは、webadmin から、またはアップグレードホストアクションを使用して開始できます。

6.109. HostCpuUnits
リンクのコピー

Expand

表6.343 メソッドの概要
名前	Summary
`list`	トポロジー (ソケット、コア) に関する詳細情報と、現在の CPU ピン留めに関する情報を含むすべてのホストの CPU のリストを返します。

6.109.1. list GET
リンクのコピー

トポロジー (ソケット、コア) に関する詳細情報と、現在の CPU ピン留めに関する情報を含むすべてのホストの CPU のリストを返します。

Expand

表6.344 パラメーターの概要
名前	型	方向	Summary
`cpu_units`	HostCpuUnit[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.109.1.1. follow
リンクのコピー

6.110. HostDevice
リンクのコピー

ホストの特定のデバイスにアクセスするためのサービス。

Expand

表6.345 メソッドの概要
名前	Summary
`get`	特定のホストのデバイスに関する情報を取得します。

6.110.1. get GET
リンクのコピー

特定のホストのデバイスに関する情報を取得します。

ホストデバイスを取得する例:

GET /ovirt-engine/api/hosts/123/devices/456

GET /ovirt-engine/api/hosts/123/devices/456

Copy to Clipboard

Toggle word wrap

<host_device href="/ovirt-engine/api/hosts/123/devices/456" id="456">
  <name>usb_1_9_1_1_0</name>
  <capability>usb</capability>
  <host href="/ovirt-engine/api/hosts/123" id="123"/>
  <parent_device href="/ovirt-engine/api/hosts/123/devices/789" id="789">
    <name>usb_1_9_1</name>
  </parent_device>
</host_device>

<host_device href="/ovirt-engine/api/hosts/123/devices/456" id="456">
  <name>usb_1_9_1_1_0</name>
  <capability>usb</capability>
  <host href="/ovirt-engine/api/hosts/123" id="123"/>
  <parent_device href="/ovirt-engine/api/hosts/123/devices/789" id="789">
    <name>usb_1_9_1</name>
  </parent_device>
</host_device>

Copy to Clipboard

Toggle word wrap

Expand

表6.346 パラメーターの概要
名前	型	方向	Summary
`device`	HostDevice	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.110.1.1. follow
リンクのコピー

6.111. HostDevices
リンクのコピー

ホストデバイスにアクセスするためのサービス。

Expand

表6.347 メソッドの概要
名前	Summary
`list`	ホストのデバイスをリスト表示します。

6.111.1. list GET
リンクのコピー

ホストのデバイスをリスト表示します。

返されるデバイスリストの順序は保証されません。

Expand

表6.348 パラメーターの概要
名前	型	方向	Summary
`devices`	HostDevice[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すデバイスの最大数を設定します。

6.111.1.1. follow
リンクのコピー

6.111.1.2. max
リンクのコピー

返すデバイスの最大数を設定します。指定しない場合、すべてのデバイスが返されます。

6.112. HostHook
リンクのコピー

Expand

表6.349 メソッドの概要
名前	Summary
`get`

6.112.1. get GET
リンクのコピー

Expand

表6.350 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hook`	Hook	Out

6.112.1.1. follow
リンクのコピー

6.113. HostHooks
リンクのコピー

Expand

表6.351 メソッドの概要
名前	Summary
`list`	ホスト用に設定されたフックのリストを返します。

6.113.1. list GET
リンクのコピー

ホスト用に設定されたフックのリストを返します。

返されるフックのリストの順序はランダムです。

Expand

表6.352 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hooks`	Hook[]	Out
`max`	Integer	In	返すフックの最大数を設定します。

6.113.1.1. follow
リンクのコピー

6.113.1.2. max
リンクのコピー

返すフックの最大数を設定します。指定されていない場合は、すべてのフックが返されます。

6.114. HostNic
リンクのコピー

ホストのネットワークインターフェイスを管理するサービス。

Expand

表6.353 メソッドの概要
名前	Summary
`get`
`updatevirtualfunctionsconfiguration`	現在のリソースが SR-IOV 対応 NIC を表す場合、アクションは仮想機能設定を更新します。

6.114.1. get GET
リンクのコピー

Expand

表6.354 パラメーターの概要
名前	型	方向	Summary
`all_content`	ブール値	In	ホストネットワークインターフェイスのすべての属性を応答に含める必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`nic`	HostNic	Out

6.114.1.1. all_content
リンクのコピー

ホストネットワークインターフェイスのすべての属性を応答に含める必要があるかどうかを示します。

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

virtual_functions_configuration

たとえば、ホスト '123' の完全な表現ネットワークインターフェイス '456' を取得するには、以下を実行します。

GET /ovirt-engine/api/hosts/123/nics/456?all_content=true

GET /ovirt-engine/api/hosts/123/nics/456?all_content=true

Copy to Clipboard

Toggle word wrap

注記

6.114.1.2. follow
リンクのコピー

6.114.2. updatevirtualfunctionsconfiguration POST
リンクのコピー

現在のリソースが SR-IOV 対応 NIC を表す場合、アクションは仮想機能設定を更新します。入力は、以下のプロパティーの少なくとも 1 つで設定されている必要があります。

allNetworksAllowed
numberOfVirtualFunctions

プロパティーの意味については、HostNicVirtualFunctionsConfiguration タイプを参照してください。

Expand

表6.355 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`virtual_functions_configuration`	HostNicVirtualFunctionsConfiguration	In

6.115. HostNics
リンクのコピー

ホストのネットワークインターフェイスを管理するサービス。

Expand

表6.356 メソッドの概要
名前	Summary
`list`	ホストのネットワークインターフェイスのリストを返します。

6.115.1. list GET
リンクのコピー

ホストのネットワークインターフェイスのリストを返します。

返されるネットワークインターフェイスのリストの順序は保証されません。

Expand

表6.357 パラメーターの概要
名前	型	方向	Summary
`all_content`	ブール値	In	ホストネットワークインターフェイスのすべての属性を応答に含める必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す NIC の最大数を設定します。
`nics`	HostNic[]	Out

6.115.1.1. all_content
リンクのコピー

ホストネットワークインターフェイスのすべての属性を応答に含める必要があるかどうかを示します。

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

virtual_functions_configuration

たとえば、ホスト '123' のネットワークインターフェイス '456' の完全な表現を取得するには、以下を実行します。

GET /ovirt-engine/api/hosts/123/nics?all_content=true

GET /ovirt-engine/api/hosts/123/nics?all_content=true

Copy to Clipboard

Toggle word wrap

注記

6.115.1.2. follow
リンクのコピー

6.115.1.3. max
リンクのコピー

返す NIC の最大数を設定します。指定されていない場合は、すべての NIC が返されます。

6.116. HostNumaNode
リンクのコピー

Expand

表6.358 メソッドの概要
名前	Summary
`get`

6.116.1. get GET
リンクのコピー

Expand

表6.359 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`ノード`	NumaNode	Out

6.116.1.1. follow
リンクのコピー

6.117. HostNumaNodes
リンクのコピー

Expand

表6.360 メソッドの概要
名前	Summary
`list`	ホストの NUMA ノードのリストを返します。

6.117.1. list GET
リンクのコピー

ホストの NUMA ノードのリストを返します。

返される NUMA ノードのリストの順序は保証されません。

Expand

表6.361 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すノードの最大数を設定します。
`nodes`	NumaNode[]	Out

6.117.1.1. follow
リンクのコピー

6.117.1.2. max
リンクのコピー

返すノードの最大数を設定します。指定されていない場合は、すべてのノードが返されます。

6.118. HostStorage
リンクのコピー

ホストストレージを管理するサービス。

Expand

表6.362 メソッドの概要
名前	Summary
`list`	ストレージのリストを取得します。

6.118.1. list GET
リンクのコピー

ストレージのリストを取得します。

GET /ovirt-engine/api/hosts/123/storage

GET /ovirt-engine/api/hosts/123/storage

Copy to Clipboard

Toggle word wrap

取得する XML 応答は次のようになります。

<host_storages>
  <host_storage id="123">
    ...
  </host_storage>
  ...
</host_storages>

<host_storages>
  <host_storage id="123">
    ...
  </host_storage>
  ...
</host_storages>

Copy to Clipboard

Toggle word wrap

返されるストレージのリストの順番は保証されていません。

Expand

表6.363 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`report_status`	ブール値	In	ストレージ内の LUN のステータスを確認する必要があるかどうかを示します。
`storages`	HostStorage[]	Out	ストレージのリストを取得しました。

6.118.1.1. follow
リンクのコピー

6.118.1.2. report_status
リンクのコピー

ストレージ内の LUN のステータスを確認する必要があるかどうかを示します。LUN のステータスの確認は非常に重要な操作であり、このデータは必ずしもユーザーが必要とするものではありません。このパラメーターは、LUN のステータスチェックを実行しないオプションを提供します。

デフォルトは、後方互換性を確保するために true です。

LUN ステータスの例を次に示します。

<host_storage id="123">
  <logical_units>
    <logical_unit id="123">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>123</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>123</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="123"/>
</host_storage>

<host_storage id="123">
  <logical_units>
    <logical_unit id="123">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>123</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>123</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="123"/>
</host_storage>

Copy to Clipboard

Toggle word wrap

これは、LUN ステータスのない例です。

<host_storage id="123">
  <logical_units>
    <logical_unit id="123">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>123</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>123</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="123"/>
</host_storage>

<host_storage id="123">
  <logical_units>
    <logical_unit id="123">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>123</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>123</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="123"/>
</host_storage>

Copy to Clipboard

Toggle word wrap

6.119. Hosts
リンクのコピー

ホストを管理するサービス。

Expand

表6.364 メソッドの概要
名前	Summary
`add`	新しいホストを作成します。
`list`	利用可能なすべてのホストのリストを取得します。

6.119.1. add POST
リンクのコピー

新しいホストを作成します。

ホストは、host パラメーターの属性に基づいて作成されます。name、address、および root_password プロパティーが必要です。

たとえば、ホストを追加するには、次のリクエストを送信します。

POST /ovirt-engine/api/hosts

POST /ovirt-engine/api/hosts

Copy to Clipboard

Toggle word wrap

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

<host>
  <name>myhost</name>
  <address>myhost.example.com</address>
  <root_password>myrootpassword</root_password>
</host>

<host>
  <name>myhost</name>
  <address>myhost.example.com</address>
  <root_password>myrootpassword</root_password>
</host>

Copy to Clipboard

Toggle word wrap

注記

root_password 要素は、クライアントが提供する初期表現にのみ含まれ、後続の要求から返される表現には公開されません。

重要

エンジンのバージョン 4.1.2 以降、ホストが新しく追加されると、デフォルトでホストのファイアウォール定義がオーバーライドされるようになりました。

ホスト型エンジンホストを追加するには、オプションの deploy_hosted_engine パラメーターを使用します。

POST /ovirt-engine/api/hosts?deploy_hosted_engine=true

POST /ovirt-engine/api/hosts?deploy_hosted_engine=true

Copy to Clipboard

Toggle word wrap

クラスターに、自動デプロイメントがサポートされているデフォルトの外部ネットワークプロバイダーがある場合、ホストの追加時に外部ネットワークプロバイダーがデプロイされます。自動デプロイメントでは、OVN の外部ネットワークプロバイダーのみがサポートされます。クラスターで定義されているもの以外の外部ネットワークプロバイダーをデプロイするには、ホストを追加するときに以下のリクエストを送信して、外部ネットワークプロバイダーを上書きします。

POST /ovirt-engine/api/hosts

POST /ovirt-engine/api/hosts

Copy to Clipboard

Toggle word wrap

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>

<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>

Copy to Clipboard

Toggle word wrap

Expand

表6.365 パラメーターの概要
名前	型	方向	Summary
`activate`	ブール値	In	`true` に設定すると、このホストはインストールの完了後にアクティブになります。
`deploy_hosted_engine`	ブール値	In	`true` に設定すると、このホストはホスト型エンジンコンポーネントをデプロイします。
`host`	ホスト	In/Out	新しいホストが作成されるホスト定義がパラメーターとして渡され、新しく作成されたホストが返されます。
`reboot`	ブール値	In	インストールに成功した後にホストを再起動するかどうかを示します。
`undeploy_hosted_engine`	ブール値	In	`true` に設定すると、このホストはホスト型エンジンコンポーネントをアンデプロイし、高可用性クラスターの一部として機能しません。

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

GET /ovirt-engine/api/hosts

Copy to Clipboard

Toggle word wrap

応答本文は次のようになります。

<hosts>
  <host href="/ovirt-engine/api/hosts/123" id="123">
    ...
  </host>
  <host href="/ovirt-engine/api/hosts/456" id="456">
    ...
  </host>
  ...
</host>

<hosts>
  <host href="/ovirt-engine/api/hosts/123" id="123">
    ...
  </host>
  <host href="/ovirt-engine/api/hosts/456" id="456">
    ...
  </host>
  ...
</host>

Copy to Clipboard

Toggle word wrap

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

Expand

表6.366 パラメーターの概要
名前	型	方向	Summary
`all_content`	ブール値	In	ホストのすべての属性を応答に含める必要があるかどうかを示します。
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`check_vms_in_affinity_closure`	ブール値	In	このパラメーターを `migration_target_of` とともに使用して、リストされた仮想マシン、およびリストされた仮想マシンとの親和性を強化している他のすべての仮想マシンの有効な移行ターゲットを取得できます。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`hosts`	Host[]	Out
`max`	Integer	In	返すホストの最大数を設定します。
`migration_target_of`	String	In	仮想マシン ID のコンマ区切りリストを受け入れ、これらの仮想マシンを移行できるホストを返します。
`search`	String	In	返されたホストを制限するために使用されるクエリー文字列。

6.119.2.1. all_content
リンクのコピー

ホストのすべての属性を応答に含める必要があるかどうかを示します。

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

hosted_engine

たとえば、ホストの完全な表現を取得するには、以下を実行します。

GET /ovirt-engine/api/hosts?all_content=true

GET /ovirt-engine/api/hosts?all_content=true

Copy to Clipboard

Toggle word wrap

注記

6.119.2.2. case_sensitive
リンクのコピー

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

GET /ovirt-engine/api/hosts?migration_target_of=123,456&check_vms_in_affinity_closure=true

Copy to Clipboard

Toggle word wrap

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

GET /ovirt-engine/api/hosts?migration_target_of=123,456

Copy to Clipboard

Toggle word wrap

6.120. アイコン
リンクのコピー

アイコンを管理するサービス (読み取り専用)。

Expand

表6.367 メソッドの概要
名前	Summary
`get`	アイコンを取得します。

6.120.1. get GET
リンクのコピー

アイコンを取得します。

GET /ovirt-engine/api/icons/123

GET /ovirt-engine/api/icons/123

Copy to Clipboard

Toggle word wrap

次のような XML 応答が得られます。

<icon id="123">
  <data>Some binary data here</data>
  <media_type>image/png</media_type>
</icon>

<icon id="123">
  <data>Some binary data here</data>
  <media_type>image/png</media_type>
</icon>

Copy to Clipboard

Toggle word wrap

Expand

表6.368 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`icon`	アイコン	Out	取得したアイコン。

6.120.1.1. follow
リンクのコピー

6.121. Icons
リンクのコピー

アイコンを管理するサービス。

Expand

表6.369 メソッドの概要
名前	Summary
`list`	アイコンのリストを取得します。

6.121.1. list GET
リンクのコピー

アイコンのリストを取得します。

GET /ovirt-engine/api/icons

GET /ovirt-engine/api/icons

Copy to Clipboard

Toggle word wrap

次のような XML 応答が得られます。

<icons>
  <icon id="123">
    <data>...</data>
    <media_type>image/png</media_type>
  </icon>
  ...
</icons>

<icons>
  <icon id="123">
    <data>...</data>
    <media_type>image/png</media_type>
  </icon>
  ...
</icons>

Copy to Clipboard

Toggle word wrap

返されるアイコンリストの順序は保証されません。

Expand

表6.370 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`icons`	Icon[]	Out	アイコンのリストを取得しました。
`max`	Integer	In	返すアイコンの最大数を設定します。

6.121.1.1. follow
リンクのコピー

6.121.1.2. max
リンクのコピー

返すアイコンの最大数を設定します。指定しない場合、すべてのアイコンが返されます。

6.122. Image
リンクのコピー

Expand

表6.371 メソッドの概要
名前	Summary
`get`
`import`	イメージをインポートします。

6.122.1. get GET
リンクのコピー

Expand

表6.372 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`image`	Image	Out

6.122.1.1. follow
リンクのコピー

6.122.2. import POST
リンクのコピー

イメージをインポートします。

import_as_template パラメーターが true の場合、イメージはテンプレートとしてインポートされます。それ以外の場合は、ディスクとしてインポートされます。

テンプレートとしてインポートする場合、テンプレートの名前はオプションの template.name パラメーターで指定することができます。このパラメーターが指定されていない場合、テンプレートの名前はエンジンによって GlanceTemplate-x として自動的に割り当てられます (x は 7 つのランダムな 16 進数文字になります)。

ディスクとしてインポートする場合、ディスクの名前はオプションの disk.name パラメーターで指定することができます。このパラメーターが指定されていない場合、ディスクの名前はエンジンによって GlanceDisk-x として自動的に割り当てられます (x はイメージ識別子の 7 つの 16 進数文字になります)。

エンジンによって自動的に生成されるこれらの名前を回避するために、テンプレートまたはディスク名を常に明示的に指定することを推奨します。

Expand

表6.373 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	インポートを非同期で実行する必要があるかどうかを示します。
`cluster`	クラスター	In	`import_as_template` パラメーターが `true` に設定されている場合に、イメージのインポート先となるクラスター。
`disk`	ディスク	In	インポートするディスク。
`import_as_template`	ブール値	In	インポートしたディスクからテンプレートを作成するかどうかを指定します。
`storage_domain`	StorageDomain	In	ディスクのインポート先となるストレージドメイン。
`テンプレート`	テンプレート	In	`import_as_template` パラメーターが `true` に設定されている場合に作成されるテンプレートの名前。

6.123. ImageTransfer
リンクのコピー

このサービスは、イメージ転送を制御するメカニズムを提供します。クライアントは、イメージ転送サービスの追加を使用し、データを転送するイメージを指定して転送を作成する必要があります。

その後、転送はこのサービスによって管理されます。

oVirt の Python の SDK を使用する:

ID が 123 の disk をアップロードします (データセンター内のランダムなホスト上に)。

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      )
   )
)

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      )
   )
)

Copy to Clipboard

Toggle word wrap

ID が 456 の host に ID が 123 の disk をアップロードします。

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      ),
      host=types.Host(
         id='456'
     )
   )
)

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      ),
      host=types.Host(
         id='456'
     )
   )
)

Copy to Clipboard

Toggle word wrap

ユーザーがディスクをアップロードではなくダウンロードしたい場合は、転送の direction 属性として download を指定する必要があります。これにより、書き込み権限ではなく、イメージからの読み取り権限が付与されます。

例:

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      ),
      direction=types.ImageTransferDirection.DOWNLOAD
   )
)

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      disk=types.Disk(
         id='123'
      ),
      direction=types.ImageTransferDirection.DOWNLOAD
   )
)

Copy to Clipboard

Toggle word wrap

転送には、アップロード/ダウンロードのフローを管理するフェーズがあります。このようなフローを実装するクライアントは、転送のフェーズをポーリング/チェックし、それに応じて動作する必要があります。想定されるすべてのフェーズは、ImageTransferPhase にあります。

新しい転送を追加した後、そのフェーズは初期化されます。クライアントは、転送が変更されるまで、転送のフェーズをポーリングする必要があります。フェーズが転送中になると、セッションは転送を開始できる状態になります。

以下に例を示します。

transfer_service = transfers_service.image_transfer_service(transfer.id)
while transfer.phase == types.ImageTransferPhase.INITIALIZING:
   time.sleep(3)
   transfer = transfer_service.get()

transfer_service = transfers_service.image_transfer_service(transfer.id)
while transfer.phase == types.ImageTransferPhase.INITIALIZING:
   time.sleep(3)
   transfer = transfer_service.get()

Copy to Clipboard

Toggle word wrap

その段階で、転送のフェーズが paused_system である場合は、セッションが正常に確立されていないことになります。これは、選択したホストで ovirt-imageio が実行されていない場合に発生する可能性があります。

Expand

表6.374 メソッドの概要
名前	Summary
`cancel`	イメージ転送セッションをキャンセルします。
`extend`	イメージ転送セッションを延長します。
`finalize`	データの転送が終了したら、転送を完了します。
`get`	イメージ転送エンティティーを取得します。
`pause`	イメージ転送セッションを一時停止します。
`再開`	イメージ転送セッションを再開します。

6.123.1. cancel POST
リンクのコピー

イメージ転送セッションをキャンセルします。これにより、転送操作が終了し、部分的なイメージが削除されます。

6.123.2. extend POST
リンクのコピー

イメージ転送セッションを延長します。

6.123.3. finalize POST
リンクのコピー

データの転送が終了したら、転送を完了します。

これにより、転送されるデータが有効であり、転送の対象となったイメージエンティティーに適合していることが確認されます。具体的には、イメージエンティティーが QCOW ディスクの場合、アップロードされたデータが実際に QCOW ファイルであり、イメージにバッキングファイルがないことを確認します。

6.123.4. get GET
リンクのコピー

イメージ転送エンティティーを取得します。

Expand

表6.375 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`image_transfer`	ImageTransfer	Out

6.123.4.1. follow
リンクのコピー

6.123.5. pause POST
リンクのコピー

イメージ転送セッションを一時停止します。

6.123.6. resume POST
リンクのコピー

イメージ転送セッションを再開します。クライアントは、転送のフェーズが resuming と異なるまで、ポーリングする必要があります。以下に例を示します。

transfer_service = transfers_service.image_transfer_service(transfer.id)
transfer_service.resume()
transfer = transfer_service.get()

while transfer.phase == types.ImageTransferPhase.RESUMING:
   time.sleep(1)
   transfer = transfer_service.get()

transfer_service = transfers_service.image_transfer_service(transfer.id)
transfer_service.resume()
transfer = transfer_service.get()

while transfer.phase == types.ImageTransferPhase.RESUMING:
   time.sleep(1)
   transfer = transfer_service.get()

Copy to Clipboard

Toggle word wrap

6.124. ImageTransfers
リンクのコピー

これは、Red Hat Virtualization の Image I/O API を実行するためのイメージ転送を管理するサービスです。詳細は、イメージ転送を参照してください。

Expand

表6.376 メソッドの概要
名前	Summary
`add`	新しいイメージ転送を追加します。
`list`	現在実行されているイメージ転送のリストを取得します。

6.124.1. add POST
リンクのコピー

新しいイメージ転送を追加します。新しい転送を行うには、イメージ、ディスク、またはディスクのスナップショットを指定する必要があります。

重要

image 属性は、エンジンのバージョン 4.2 以降非推奨になりました。代わりに、disk または snapshot の属性を使用してください。

disk をダウンロードまたはアップロードするための新しいイメージ転送の作成:

ID 123 のディスクをダウンロードまたはアップロードするためのイメージ転送を作成するには、次のリクエストを送信します。

POST /ovirt-engine/api/imagetransfers

POST /ovirt-engine/api/imagetransfers

Copy to Clipboard

Toggle word wrap

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

<image_transfer>
  <disk id="123"/>
  <direction>upload|download</direction>
</image_transfer>

<image_transfer>
  <disk id="123"/>
  <direction>upload|download</direction>
</image_transfer>

Copy to Clipboard

Toggle word wrap

disk_snapshot をダウンロードまたはアップロードするための新しいイメージ転送の作成:

ID 456 の disk_snapshot をダウンロードまたはアップロードするためのイメージ転送を作成するには、次のリクエストを送信します。

POST /ovirt-engine/api/imagetransfers

POST /ovirt-engine/api/imagetransfers

Copy to Clipboard

Toggle word wrap

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

<image_transfer>
  <snapshot id="456"/>
  <direction>download|upload</direction>
</image_transfer>

<image_transfer>
  <snapshot id="456"/>
  <direction>download|upload</direction>
</image_transfer>

Copy to Clipboard

Toggle word wrap

Expand

表6.377 パラメーターの概要
名前	型	方向	Summary
`image_transfer`	ImageTransfer	In/Out	追加するイメージ転送。

6.124.2. list GET
リンクのコピー

現在実行されているイメージ転送のリストを取得します。

返されるイメージ転送リストの順序は保証されません。

Expand

表6.378 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`image_transfer`	ImageTransfer[]	Out	現在実行されているイメージ転送のリスト。

6.124.2.1. follow
リンクのコピー

6.125. イメージ
リンクのコピー

ストレージドメインまたは OpenStack イメージプロバイダーで利用可能なイメージのセットを管理します。

Expand

表6.379 メソッドの概要
名前	Summary
`list`	ストレージドメインまたはプロバイダーで使用可能なイメージのリストを返します。

6.125.1. list GET
リンクのコピー

ストレージドメインまたはプロバイダーで使用可能なイメージのリストを返します。

返されるイメージリストの順序は保証されません。

Expand

表6.380 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`images`	Image[]	Out
`max`	Integer	In	返すイメージの最大数を設定します。

6.125.1.1. follow
リンクのコピー

6.125.1.2. max
リンクのコピー

返すイメージの最大数を設定します。指定しない場合、すべてのイメージが返されます。

6.126. InstanceType
リンクのコピー

Expand

表6.381 メソッドの概要
名前	Summary
`get`	特定のインスタンスタイプとその属性を取得します。
`remove`	システムから特定のインスタンスタイプを削除します。
`update`	特定のインスタンスタイプとその属性を更新します。

6.126.1. get GET
リンクのコピー

特定のインスタンスタイプとその属性を取得します。

GET /ovirt-engine/api/instancetypes/123

GET /ovirt-engine/api/instancetypes/123

Copy to Clipboard

Toggle word wrap

Expand

表6.382 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`instance_type`	InstanceType	Out

6.126.1.1. follow
リンクのコピー

6.126.2. remove DELETE
リンクのコピー

システムから特定のインスタンスタイプを削除します。

インスタンスタイプの削除後にインスタンスタイプ X を使用して仮想マシンが作成された場合、仮想マシンのインスタンスタイプは custom に設定されます。

DELETE /ovirt-engine/api/instancetypes/123

DELETE /ovirt-engine/api/instancetypes/123

Copy to Clipboard

Toggle word wrap

Expand

表6.383 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.126.3. update PUT
リンクのコピー

特定のインスタンスタイプとその属性を更新します。

すべての属性は、作成後に編集可能です。インスタンスタイプ X を使用して仮想マシンが作成され、インスタンスタイプ X の一部の設定が更新された場合、仮想マシンの設定はエンジンによって自動的に更新されます。

PUT /ovirt-engine/api/instancetypes/123

PUT /ovirt-engine/api/instancetypes/123

Copy to Clipboard

Toggle word wrap

たとえば、インスタンスタイプ 123 のメモリーを 1 GiB に更新し、CPU トポロジーを 2 ソケットと 1 コアに設定するには、以下のようなリクエストを送信します。

<instance_type>
  <memory>1073741824</memory>
  <cpu>
    <topology>
      <cores>1</cores>
      <sockets>2</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
</instance_type>

<instance_type>
  <memory>1073741824</memory>
  <cpu>
    <topology>
      <cores>1</cores>
      <sockets>2</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
</instance_type>

Copy to Clipboard

Toggle word wrap

Expand

表6.384 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`instance_type`	InstanceType	In/Out

6.127. InstanceTypeGraphicsConsole
リンクのコピー

Expand

表6.385 メソッドの概要
名前	Summary
`get`	インスタンスタイプのグラフィックコンソール設定を取得します。
`remove`	インスタンスタイプからグラフィックコンソールを削除します。

6.127.1. get GET
リンクのコピー

インスタンスタイプのグラフィックコンソール設定を取得します。

Expand

表6.386 パラメーターの概要
名前	型	方向	Summary
`console`	GraphicsConsole	Out	インスタンスタイプのグラフィックコンソールに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.127.1.1. follow
リンクのコピー

6.127.2. remove DELETE
リンクのコピー

インスタンスタイプからグラフィックコンソールを削除します。

Expand

表6.387 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.128. InstanceTypeGraphicsConsoles
リンクのコピー

Expand

表6.388 メソッドの概要
名前	Summary
`add`	インスタンスタイプに新しいグラフィックコンソールを追加します。
`list`	インスタンスタイプの設定済みグラフィックコンソールをすべてリスト表示します。

6.128.1. add POST
リンクのコピー

インスタンスタイプに新しいグラフィックコンソールを追加します。

Expand

表6.389 パラメーターの概要
名前	型	方向	Summary
`console`	GraphicsConsole	In/Out

6.128.2. list GET
リンクのコピー

インスタンスタイプの設定済みグラフィックコンソールをすべてリスト表示します。

返されるグラフィックコンソールリストの順序は保証されません。

Expand

表6.390 パラメーターの概要
名前	型	方向	Summary
`consoles`	GraphicsConsole[]	Out	インスタンスタイプのグラフィックコンソールのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すコンソールの最大数を設定します。

6.128.2.1. follow
リンクのコピー

6.128.2.2. max
リンクのコピー

返すコンソールの最大数を設定します。指定しない場合、すべてのコンソールが返されます。

6.129. InstanceTypeNic
リンクのコピー

Expand

表6.391 メソッドの概要
名前	Summary
`get`	インスタンスタイプのネットワークインターフェイス設定を取得します。
`remove`	インスタンスタイプからネットワークインターフェイスを削除します。
`update`	インスタンスタイプのネットワークインターフェイス設定を更新します。

6.129.1. get GET
リンクのコピー

インスタンスタイプのネットワークインターフェイス設定を取得します。

Expand

表6.392 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`nic`	Nic	Out

6.129.1.1. follow
リンクのコピー

6.129.2. remove DELETE
リンクのコピー

インスタンスタイプからネットワークインターフェイスを削除します。

Expand

表6.393 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.129.3. update PUT
リンクのコピー

インスタンスタイプのネットワークインターフェイス設定を更新します。

Expand

表6.394 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`nic`	Nic	In/Out

6.130. InstanceTypeNics
リンクのコピー

Expand

表6.395 メソッドの概要
名前	Summary
`add`	インスタンスタイプに新しいネットワークインターフェイスを追加します。
`list`	インスタンスタイプの設定済みネットワークインターフェイスをすべてリスト表示します。

6.130.1. add POST
リンクのコピー

インスタンスタイプに新しいネットワークインターフェイスを追加します。

Expand

表6.396 パラメーターの概要
名前	型	方向	Summary
`nic`	Nic	In/Out

6.130.2. list GET
リンクのコピー

インスタンスタイプの設定済みネットワークインターフェイスをすべてリスト表示します。

返されるネットワークインターフェイスのリストの順序は保証されません。

Expand

表6.397 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す NIC の最大数を設定します。
`nics`	Nic[]	Out
`search`	String	In	返されたボリュームを制限するために使用されるクエリー文字列です。

6.130.2.1. follow
リンクのコピー

6.130.2.2. max
リンクのコピー

返す NIC の最大数を設定します。指定されていない場合は、すべての NIC が返されます。

6.131. InstanceTypeWatchdog
リンクのコピー

Expand

表6.398 メソッドの概要
名前	Summary
`get`	インスタンスタイプのウォッチドッグ設定を取得します。
`remove`	インスタンスタイプからウォッチドッグを削除します。
`update`	インスタンスタイプのウォッチドッグ設定を更新します。

6.131.1. get GET
リンクのコピー

インスタンスタイプのウォッチドッグ設定を取得します。

Expand

表6.399 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`watchdog`	Watchdog	Out

6.131.1.1. follow
リンクのコピー

6.131.2. remove DELETE
リンクのコピー

インスタンスタイプからウォッチドッグを削除します。

Expand

表6.400 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.131.3. update PUT
リンクのコピー

インスタンスタイプのウォッチドッグ設定を更新します。

Expand

表6.401 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`watchdog`	Watchdog	In/Out

6.132. InstanceTypeWatchdogs
リンクのコピー

Expand

表6.402 メソッドの概要
名前	Summary
`add`	インスタンスタイプに新しいウォッチドッグを追加します。
`list`	インスタンスタイプの設定済みウォッチドッグをすべてリスト表示します。

6.132.1. add POST
リンクのコピー

インスタンスタイプに新しいウォッチドッグを追加します。

Expand

表6.403 パラメーターの概要
名前	型	方向	Summary
`watchdog`	Watchdog	In/Out

6.132.2. list GET
リンクのコピー

インスタンスタイプの設定済みウォッチドッグをすべてリスト表示します。

返されるウォッチドッグリストの順序は保証されません。

Expand

表6.404 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すウォッチドッグの最大数を設定します。
`search`	String	In	返されたボリュームを制限するために使用されるクエリー文字列です。
`watchdogs`	Watchdog[]	Out

6.132.2.1. follow
リンクのコピー

6.132.2.2. max
リンクのコピー

返すウォッチドッグの最大数を設定します。指定しない場合、すべてのウォッチドッグが返されます。

6.133. InstanceTypes
リンクのコピー

Expand

表6.405 メソッドの概要
名前	Summary
`add`	新しいインスタンスタイプを作成します。
`list`	システム内の既存のすべてのインスタンスタイプをリスト表示します。

6.133.1. add POST
リンクのコピー

新しいインスタンスタイプを作成します。

これには name 属性のみが必要であり、仮想マシンのすべてのハードウェア設定を含めることができます。

POST /ovirt-engine/api/instancetypes

POST /ovirt-engine/api/instancetypes

Copy to Clipboard

Toggle word wrap

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

<instance_type>
  <name>myinstancetype</name>
</template>

<instance_type>
  <name>myinstancetype</name>
</template>

Copy to Clipboard

Toggle word wrap

次のようなリクエスト本文を使用して、すべてのハードウェア設定でインスタンスタイプを作成します。

<instance_type>
  <name>myinstancetype</name>
  <console>
    <enabled>true</enabled>
  </console>
  <cpu>
    <topology>
      <cores>2</cores>
      <sockets>2</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
  <custom_cpu_model>AMD Opteron_G2</custom_cpu_model>
  <custom_emulated_machine>q35</custom_emulated_machine>
  <display>
    <monitors>1</monitors>
    <single_qxl_pci>true</single_qxl_pci>
    <smartcard_enabled>true</smartcard_enabled>
    <type>spice</type>
  </display>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <io>
    <threads>2</threads>
  </io>
  <memory>4294967296</memory>
  <memory_policy>
    <ballooning>true</ballooning>
    <guaranteed>268435456</guaranteed>
  </memory_policy>
  <migration>
    <auto_converge>inherit</auto_converge>
    <compressed>inherit</compressed>
    <policy id="00000000-0000-0000-0000-000000000000"/>
  </migration>
  <migration_downtime>2</migration_downtime>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
  <rng_device>
    <rate>
      <bytes>200</bytes>
      <period>2</period>
    </rate>
    <source>urandom</source>
  </rng_device>
  <soundcard_enabled>true</soundcard_enabled>
  <usb>
    <enabled>true</enabled>
    <type>native</type>
  </usb>
  <virtio_scsi>
    <enabled>true</enabled>
  </virtio_scsi>
</instance_type>

<instance_type>
  <name>myinstancetype</name>
  <console>
    <enabled>true</enabled>
  </console>
  <cpu>
    <topology>
      <cores>2</cores>
      <sockets>2</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
  <custom_cpu_model>AMD Opteron_G2</custom_cpu_model>
  <custom_emulated_machine>q35</custom_emulated_machine>
  <display>
    <monitors>1</monitors>
    <single_qxl_pci>true</single_qxl_pci>
    <smartcard_enabled>true</smartcard_enabled>
    <type>spice</type>
  </display>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <io>
    <threads>2</threads>
  </io>
  <memory>4294967296</memory>
  <memory_policy>
    <ballooning>true</ballooning>
    <guaranteed>268435456</guaranteed>
  </memory_policy>
  <migration>
    <auto_converge>inherit</auto_converge>
    <compressed>inherit</compressed>
    <policy id="00000000-0000-0000-0000-000000000000"/>
  </migration>
  <migration_downtime>2</migration_downtime>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
  <rng_device>
    <rate>
      <bytes>200</bytes>
      <period>2</period>
    </rate>
    <source>urandom</source>
  </rng_device>
  <soundcard_enabled>true</soundcard_enabled>
  <usb>
    <enabled>true</enabled>
    <type>native</type>
  </usb>
  <virtio_scsi>
    <enabled>true</enabled>
  </virtio_scsi>
</instance_type>

Copy to Clipboard

Toggle word wrap

Expand

表6.406 パラメーターの概要
名前	型	方向	Summary
`instance_type`	InstanceType	In/Out

6.133.2. list GET
リンクのコピー

システム内の既存のすべてのインスタンスタイプをリスト表示します。

返されるインスタンスタイプリストの順序は保証されません。

Expand

表6.407 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`instance_type`	InstanceType[]	Out
`max`	Integer	In	返すインスタンスタイプの最大数を設定します。
`search`	String	In	返されたボリュームを制限するために使用されるクエリー文字列です。

6.133.2.1. case_sensitive
リンクのコピー

6.133.2.2. follow
リンクのコピー

6.133.2.3. max
リンクのコピー

返すインスタンスタイプの最大数を設定します。指定しない場合、すべてのインスタンスタイプが返されます。

6.134. IscsiBond
リンクのコピー

Expand

表6.408 メソッドの概要
名前	Summary
`get`
`remove`	既存の iSCSI ボンディングを削除します。
`update`	iSCSI ボンディングを更新します。

6.134.1. get GET
リンクのコピー

Expand

表6.409 パラメーターの概要
名前	型	方向	Summary
`bond`	IscsiBond	Out	iSCSI ボンディング。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.134.1.1. follow
リンクのコピー

6.134.2. remove DELETE
リンクのコピー

既存の iSCSI ボンディングを削除します。

たとえば、iSCSI ボンディング 456 を削除するには、次のようなリクエストを送信します。

DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456

DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456

Copy to Clipboard

Toggle word wrap

Expand

表6.410 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.134.3. update PUT
リンクのコピー

iSCSI ボンディングを更新します。

iSCSI ボンディングの更新は、name 属性と description 属性でのみ実行できます。たとえば、データセンター 123 の iSCSI ボンディング 456 を更新するには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234

PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234

Copy to Clipboard

Toggle word wrap

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

<iscsi_bond>
   <name>mybond</name>
   <description>My iSCSI bond</description>
</iscsi_bond>

<iscsi_bond>
   <name>mybond</name>
   <description>My iSCSI bond</description>
</iscsi_bond>

Copy to Clipboard

Toggle word wrap

Expand

表6.411 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`bond`	IscsiBond	In/Out	更新する iSCSI ボンディング。

6.135. IscsiBonds
リンクのコピー

Expand

表6.412 メソッドの概要
名前	Summary
`add`	データセンターに新しい iSCSI ボンディングを作成します。
`list`	データセンターで設定されている iSCSI ボンディングのリストを返します。

6.135.1. add POST
リンクのコピー

データセンターに新しい iSCSI ボンディングを作成します。

たとえば、ストレージ接続 456 および 789 を使用してデータセンター 123 に新しい iSCSI ボンディングを作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/datacenters/123/iscsibonds

POST /ovirt-engine/api/datacenters/123/iscsibonds

Copy to Clipboard

Toggle word wrap

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

<iscsi_bond>
  <name>mybond</name>
  <storage_connections>
    <storage_connection id="456"/>
    <storage_connection id="789"/>
  </storage_connections>
  <networks>
    <network id="abc"/>
  </networks>
</iscsi_bond>

<iscsi_bond>
  <name>mybond</name>
  <storage_connections>
    <storage_connection id="456"/>
    <storage_connection id="789"/>
  </storage_connections>
  <networks>
    <network id="abc"/>
  </networks>
</iscsi_bond>

Copy to Clipboard

Toggle word wrap

Expand

表6.413 パラメーターの概要
名前	型	方向	Summary
`bond`	IscsiBond	In/Out

6.135.2. list GET
リンクのコピー

データセンターで設定されている iSCSI ボンディングのリストを返します。

返される iSCSI ボンディングリストの順序は保証されません。

Expand

表6.414 パラメーターの概要
名前	型	方向	Summary
`bonds`	IscsiBond[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すボンディングの最大数を設定します。

6.135.2.1. follow
リンクのコピー

6.135.2.2. max
リンクのコピー

返すボンディングの最大数を設定します。指定しない場合、すべてのボンディングが返されます。

6.136. ジョブ
リンクのコピー

ジョブを管理するサービス

Expand

表6.415 メソッドの概要
名前	Summary
`clear`	システムによってクリアされる外部ジョブの実行を設定します。
`end`	外部ジョブの実行を終了としてマークします。
`get`	ジョブを取得します。

6.136.1. clear POST
リンクのコピー

システムによってクリアされる外部ジョブの実行を設定します。

たとえば、識別子 123 でジョブを設定するには、次の要求を送信します。

POST /ovirt-engine/api/jobs/clear

POST /ovirt-engine/api/jobs/clear

Copy to Clipboard

Toggle word wrap

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

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.416 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.136.2. end POST
リンクのコピー

外部ジョブの実行を終了としてマークします。

たとえば、識別子 123 でジョブを終了するには、次の要求を送信します。

POST /ovirt-engine/api/jobs/end

POST /ovirt-engine/api/jobs/end

Copy to Clipboard

Toggle word wrap

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

<action>
  <force>true</force>
  <status>finished</status>
</action>

<action>
  <force>true</force>
  <status>finished</status>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.417 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In	ジョブを強制終了する必要があるかどうかを示します。
`succeeded`	ブール値	In	ジョブを正常終了または失敗としてマークする必要があるかどうかを示します。

6.136.2.1. succeeded
リンクのコピー

ジョブを正常終了または失敗としてマークする必要があるかどうかを示します。

このパラメーターはオプションであり、デフォルト値は true です。

6.136.3. get GET
リンクのコピー

ジョブを取得します。

GET /ovirt-engine/api/jobs/123

GET /ovirt-engine/api/jobs/123

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<job href="/ovirt-engine/api/jobs/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
    <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
  </actions>
  <description>Adding Disk</description>
  <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
  <auto_cleared>true</auto_cleared>
  <end_time>2016-12-12T23:07:29.758+02:00</end_time>
  <external>false</external>
  <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
  <start_time>2016-12-12T23:07:26.593+02:00</start_time>
  <status>failed</status>
  <owner href="/ovirt-engine/api/users/456" id="456"/>
</job>

<job href="/ovirt-engine/api/jobs/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
    <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
  </actions>
  <description>Adding Disk</description>
  <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
  <auto_cleared>true</auto_cleared>
  <end_time>2016-12-12T23:07:29.758+02:00</end_time>
  <external>false</external>
  <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
  <start_time>2016-12-12T23:07:26.593+02:00</start_time>
  <status>failed</status>
  <owner href="/ovirt-engine/api/users/456" id="456"/>
</job>

Copy to Clipboard

Toggle word wrap

Expand

表6.418 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`job`	ジョブ	Out	ジョブの表現を取得します。

6.136.3.1. follow
リンクのコピー

6.137. ジョブ
リンクのコピー

ジョブを管理するサービス。

Expand

表6.419 メソッドの概要
名前	Summary
`add`	外部ジョブを追加します。
`list`	ジョブの表現を取得します。

6.137.1. add POST
リンクのコピー

外部ジョブを追加します。

たとえば、次のリクエストでジョブを追加する場合で、

POST /ovirt-engine/api/jobs

POST /ovirt-engine/api/jobs

Copy to Clipboard

Toggle word wrap

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

<job>
  <description>Doing some work</description>
  <auto_cleared>true</auto_cleared>
</job>

<job>
  <description>Doing some work</description>
  <auto_cleared>true</auto_cleared>
</job>

Copy to Clipboard

Toggle word wrap

応答は以下のようになります。

<job href="/ovirt-engine/api/jobs/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
    <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
  </actions>
  <description>Doing some work</description>
  <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
  <auto_cleared>true</auto_cleared>
  <external>true</external>
  <last_updated>2016-12-13T02:15:42.130+02:00</last_updated>
  <start_time>2016-12-13T02:15:42.130+02:00</start_time>
  <status>started</status>
  <owner href="/ovirt-engine/api/users/456" id="456"/>
</job>

<job href="/ovirt-engine/api/jobs/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
    <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
  </actions>
  <description>Doing some work</description>
  <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
  <auto_cleared>true</auto_cleared>
  <external>true</external>
  <last_updated>2016-12-13T02:15:42.130+02:00</last_updated>
  <start_time>2016-12-13T02:15:42.130+02:00</start_time>
  <status>started</status>
  <owner href="/ovirt-engine/api/users/456" id="456"/>
</job>

Copy to Clipboard

Toggle word wrap

Expand

表6.420 パラメーターの概要
名前	型	方向	Summary
`job`	ジョブ	In/Out	追加されるジョブ。

6.137.2. list GET
リンクのコピー

ジョブの表現を取得します。

GET /ovirt-engine/api/jobs

GET /ovirt-engine/api/jobs

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<jobs>
  <job href="/ovirt-engine/api/jobs/123" id="123">
    <actions>
      <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
      <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
    </actions>
    <description>Adding Disk</description>
    <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
    <auto_cleared>true</auto_cleared>
    <end_time>2016-12-12T23:07:29.758+02:00</end_time>
    <external>false</external>
    <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
    <start_time>2016-12-12T23:07:26.593+02:00</start_time>
    <status>failed</status>
    <owner href="/ovirt-engine/api/users/456" id="456"/>
  </job>
  ...
</jobs>

<jobs>
  <job href="/ovirt-engine/api/jobs/123" id="123">
    <actions>
      <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
      <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
    </actions>
    <description>Adding Disk</description>
    <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
    <auto_cleared>true</auto_cleared>
    <end_time>2016-12-12T23:07:29.758+02:00</end_time>
    <external>false</external>
    <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
    <start_time>2016-12-12T23:07:26.593+02:00</start_time>
    <status>failed</status>
    <owner href="/ovirt-engine/api/users/456" id="456"/>
  </job>
  ...
</jobs>

Copy to Clipboard

Toggle word wrap

返されるジョブリストの順序は保証されません。

Expand

表6.421 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`jobs`	Job[]	Out	ジョブの表現。
`max`	Integer	In	返すジョブの最大数を設定します。
`search`	String	In	返されたホストを制限するために使用されるクエリー文字列。

6.137.2.1. case_sensitive
リンクのコピー

6.137.2.2. follow
リンクのコピー

6.137.2.3. max
リンクのコピー

返すジョブの最大数を設定します。指定されていない場合は、すべてのジョブが返されます。

6.138. KatelloErrata
リンクのコピー

Katello エラータを管理するサービスです。この情報は Katello から取得されます。

Expand

表6.422 メソッドの概要
名前	Summary
`list`	Katello エラータの表現を取得します。

6.138.1. list GET
リンクのコピー

Katello エラータの表現を取得します。

GET /ovirt-engine/api/katelloerrata

GET /ovirt-engine/api/katelloerrata

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

Copy to Clipboard

Toggle word wrap

返されたエラータリストの順序は保証されません。

Expand

表6.423 パラメーターの概要
名前	型	方向	Summary
`errata`	KatelloErratum[]	Out	Katello エラータの表現。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すエラータの最大数を設定します。

6.138.1.1. follow
リンクのコピー

6.138.1.2. max
リンクのコピー

返すエラータの最大数を設定します。指定されていない場合は、すべてのエラータが返されます。

6.139. KatelloErratum
リンクのコピー

Katello エラータを管理するサービスです。

Expand

表6.424 メソッドの概要
名前	Summary
`get`	Katello エラータを取得します。

6.139.1. get GET
リンクのコピー

Katello エラータを取得します。

GET /ovirt-engine/api/katelloerrata/123

GET /ovirt-engine/api/katelloerrata/123

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
  <name>RHBA-2013:XYZ</name>
  <description>The description of the erratum</description>
  <title>some bug fix update</title>
  <type>bugfix</type>
  <issued>2013-11-20T02:00:00.000+02:00</issued>
  <solution>Few guidelines regarding the solution</solution>
  <summary>Updated packages that fix one bug are now available for XYZ</summary>
  <packages>
    <package>
      <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
    </package>
    ...
  </packages>
</katello_erratum>

<katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
  <name>RHBA-2013:XYZ</name>
  <description>The description of the erratum</description>
  <title>some bug fix update</title>
  <type>bugfix</type>
  <issued>2013-11-20T02:00:00.000+02:00</issued>
  <solution>Few guidelines regarding the solution</solution>
  <summary>Updated packages that fix one bug are now available for XYZ</summary>
  <packages>
    <package>
      <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
    </package>
    ...
  </packages>
</katello_erratum>

Copy to Clipboard

Toggle word wrap

Expand

表6.425 パラメーターの概要
名前	型	方向	Summary
`erratum`	KatelloErratum	Out	Katello エラータの表現を取得します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.139.1.1. follow
リンクのコピー

6.140. LinkLayerDiscoveryProtocol
リンクのコピー

Link Layer Discovery Protocol (LLDP) によって受信された情報要素を取得するサービス。

Expand

表6.426 メソッドの概要
名前	Summary
`list`	LLDP によって受信された情報要素を取得します。

6.140.1. list GET
リンクのコピー

LLDP によって受信された情報要素を取得します。

Expand

表6.427 パラメーターの概要
名前	型	方向	Summary
`element`	LinkLayerDiscoveryProtocolElement[]	Out	LLDP が受信した情報要素のリストを取得します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.140.1.1. element
リンクのコピー

LLDP が受信した情報要素のリストを取得します。

たとえば、ホスト 123 の NIC 321 で受信した情報要素を取得するには、以下のようなリクエストを送信します。

GET ovirt-engine/api/hosts/123/nics/321/linklayerdiscoveryprotocolelements

GET ovirt-engine/api/hosts/123/nics/321/linklayerdiscoveryprotocolelements

Copy to Clipboard

Toggle word wrap

以下のような応答が返されます。

<link_layer_discovery_protocol_elements>
    ...
  <link_layer_discovery_protocol_element>
    <name>Port Description</name>
    <properties>
      <property>
        <name>port description</name>
        <value>Summit300-48-Port 1001</value>
      </property>
    </properties>
    <type>4</type>
  </link_layer_discovery_protocol_element>
  ...
<link_layer_discovery_protocol_elements>

<link_layer_discovery_protocol_elements>
    ...
  <link_layer_discovery_protocol_element>
    <name>Port Description</name>
    <properties>
      <property>
        <name>port description</name>
        <value>Summit300-48-Port 1001</value>
      </property>
    </properties>
    <type>4</type>
  </link_layer_discovery_protocol_element>
  ...
<link_layer_discovery_protocol_elements>

Copy to Clipboard

Toggle word wrap

6.140.1.2. follow
リンクのコピー

6.141. MacPool
リンクのコピー

Expand

表6.428 メソッドの概要
名前	Summary
`get`
`remove`	MAC アドレスプールを削除します。
`update`	MAC アドレスプールを更新します。

6.141.1. get GET
リンクのコピー

Expand

表6.429 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`pool`	MacPool	Out

6.141.1.1. follow
リンクのコピー

6.141.2. remove DELETE
リンクのコピー

MAC アドレスプールを削除します。

たとえば、ID が 123 の MAC アドレスプールを削除するには、次のようなリクエストを送信します。

DELETE /ovirt-engine/api/macpools/123

DELETE /ovirt-engine/api/macpools/123

Copy to Clipboard

Toggle word wrap

Expand

表6.430 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.141.3. update PUT
リンクのコピー

MAC アドレスプールを更新します。

name、description、allow_duplicates、および ranges 属性を更新できます。

たとえば、ID 123 の MAC アドレスプールを更新するには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/macpools/123

PUT /ovirt-engine/api/macpools/123

Copy to Clipboard

Toggle word wrap

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

<mac_pool>
  <name>UpdatedMACPool</name>
  <description>An updated MAC address pool</description>
  <allow_duplicates>false</allow_duplicates>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:e6</to>
    </range>
    <range>
      <from>02:1A:4A:01:00:00</from>
      <to>02:1A:4A:FF:FF:FF</to>
    </range>
  </ranges>
</mac_pool>

<mac_pool>
  <name>UpdatedMACPool</name>
  <description>An updated MAC address pool</description>
  <allow_duplicates>false</allow_duplicates>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:e6</to>
    </range>
    <range>
      <from>02:1A:4A:01:00:00</from>
      <to>02:1A:4A:FF:FF:FF</to>
    </range>
  </ranges>
</mac_pool>

Copy to Clipboard

Toggle word wrap

Expand

表6.431 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`pool`	MacPool	In/Out

6.142. MacPools
リンクのコピー

Expand

表6.432 メソッドの概要
名前	Summary
`add`	新しい MAC アドレスプールを作成します。
`list`	システムの MAC アドレスプールのリストを返します。

6.142.1. add POST
リンクのコピー

新しい MAC アドレスプールを作成します。

MAC アドレスプールを作成するには、name 属性と range 属性の値が必要です。

たとえば、MAC アドレスプールを作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/macpools

POST /ovirt-engine/api/macpools

Copy to Clipboard

Toggle word wrap

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

<mac_pool>
  <name>MACPool</name>
  <description>A MAC address pool</description>
  <allow_duplicates>true</allow_duplicates>
  <default_pool>false</default_pool>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:e6</to>
    </range>
  </ranges>
</mac_pool>

<mac_pool>
  <name>MACPool</name>
  <description>A MAC address pool</description>
  <allow_duplicates>true</allow_duplicates>
  <default_pool>false</default_pool>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:e6</to>
    </range>
  </ranges>
</mac_pool>

Copy to Clipboard

Toggle word wrap

Expand

表6.433 パラメーターの概要
名前	型	方向	Summary
`pool`	MacPool	In/Out

6.142.2. list GET
リンクのコピー

システムの MAC アドレスプールのリストを返します。

返される MAC アドレスプールのリストは保証されません。

Expand

表6.434 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプールの最大数を設定します。
`pools`	MacPool[]	Out

6.142.2.1. follow
リンクのコピー

6.142.2.2. max
リンクのコピー

返すプールの最大数を設定します。指定されていない場合は、すべてのプールが返されます。

6.143. Measurable
リンクのコピー

6.144. Moveable
リンクのコピー

Expand

表6.435 メソッドの概要
名前	Summary
`move`

6.144.1. move POST
リンクのコピー

Expand

表6.436 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	移動を非同期で実行する必要があるかどうかを示します。

6.145. Network
リンクのコピー

ネットワークを管理するサービス

Expand

表6.437 メソッドの概要
名前	Summary
`get`	論理ネットワークを取得します。
`remove`	論理ネットワーク、または論理ネットワークのデータセンターへの関連付けを削除します。
`update`	論理ネットワークを更新します。

6.145.1. get GET
リンクのコピー

論理ネットワークを取得します。

以下に例を示します。

GET /ovirt-engine/api/networks/123

GET /ovirt-engine/api/networks/123

Copy to Clipboard

Toggle word wrap

以下を応答します。

<network href="/ovirt-engine/api/networks/123" id="123">
  <name>ovirtmgmt</name>
  <description>Default Management Network</description>
  <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
  <mtu>0</mtu>
  <stp>false</stp>
  <usages>
    <usage>vm</usage>
  </usages>
  <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
</network>

<network href="/ovirt-engine/api/networks/123" id="123">
  <name>ovirtmgmt</name>
  <description>Default Management Network</description>
  <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
  <mtu>0</mtu>
  <stp>false</stp>
  <usages>
    <usage>vm</usage>
  </usages>
  <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
</network>

Copy to Clipboard

Toggle word wrap

Expand

表6.438 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`network`	Network	Out

6.145.1.1. follow
リンクのコピー

6.145.2. remove DELETE
リンクのコピー

論理ネットワーク、または論理ネットワークのデータセンターへの関連付けを削除します。

たとえば、論理ネットワーク 123 を削除するには、以下のような要求を送信します。

DELETE /ovirt-engine/api/networks/123

DELETE /ovirt-engine/api/networks/123

Copy to Clipboard

Toggle word wrap

各ネットワークは、1 つのデータセンターに厳密にバインドされています。したがって、ネットワークとデータセンターの関連付けを解除すると、そのネットワークを単に削除した場合と同じ結果になります。ただし、データセンター 123 のネットワーク 456 を削除すると言う方がより具体的かもしれません。

たとえば、ネットワーク 456 とデータセンター 123 の関連付けを削除するには、以下のような要求を送信します。

DELETE /ovirt-engine/api/datacenters/123/networks/456

DELETE /ovirt-engine/api/datacenters/123/networks/456

Copy to Clipboard

Toggle word wrap

注記

外部論理ネットワークを削除するには、OpenStack Networking API を使用して、そのプロバイダーから直接ネットワークを削除する必要があります。プロバイダーで auto_sync が有効になっている場合、Red Hat Virtualization 内の外部ネットワークを表すエンティティーは自動的に削除されます。それ以外の場合は、このメソッドを使用してエンティティーを削除する必要があります。

Expand

表6.439 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.145.3. update PUT
リンクのコピー

論理ネットワークを更新します。

name、description、ip、vlan、stp、および display 属性を更新できます。

たとえば、論理ネットワーク 123 の説明を更新するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/networks/123

PUT /ovirt-engine/api/networks/123

Copy to Clipboard

Toggle word wrap

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

<network>
  <description>My updated description</description>
</network>

<network>
  <description>My updated description</description>
</network>

Copy to Clipboard

Toggle word wrap

ネットワークの最大伝送単位は、mtu 属性の整数値を指定する PUT 要求を使用して設定されます。

たとえば、最大伝送単位を設定するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/datacenters/123/networks/456

PUT /ovirt-engine/api/datacenters/123/networks/456

Copy to Clipboard

Toggle word wrap

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

<network>
  <mtu>1500</mtu>
</network>

<network>
  <mtu>1500</mtu>
</network>

Copy to Clipboard

Toggle word wrap

注記

外部ネットワークの更新はプロバイダーに伝播されません。

Expand

表6.440 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`network`	Network	In/Out

6.146. NetworkAttachment
リンクのコピー

Expand

表6.441 メソッドの概要
名前	Summary
`get`
`remove`
`update`	ホスト上の指定されたネットワークアタッチメントを更新します。

6.146.1. get GET
リンクのコピー

Expand

表6.442 パラメーターの概要
名前	型	方向	Summary
`attachment`	NetworkAttachment	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.146.1.1. follow
リンクのコピー

6.146.2. remove DELETE
リンクのコピー

Expand

表6.443 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.146.3. update PUT
リンクのコピー

ホスト上の指定されたネットワークアタッチメントを更新します。

Expand

表6.444 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`attachment`	NetworkAttachment	In/Out

6.147. NetworkAttachments
リンクのコピー

ホストまたはホスト NIC のネットワークアタッチメントのセットを管理します。

Expand

表6.445 メソッドの概要
名前	Summary
`add`	ネットワークインターフェイスに新しいネットワークアタッチメントを追加します。
`list`	ホストまたはホスト NIC のネットワークアタッチメントのリストを返します。

6.147.1. add POST
リンクのコピー

ネットワークインターフェイスに新しいネットワークアタッチメントを追加します。

Expand

表6.446 パラメーターの概要
名前	型	方向	Summary
`attachment`	NetworkAttachment	In/Out

6.147.2. list GET
リンクのコピー

ホストまたはホスト NIC のネットワークアタッチメントのリストを返します。

返されるネットワークアタッチメントリストの順序は保証されません。

Expand

表6.447 パラメーターの概要
名前	型	方向	Summary
`attachments`	NetworkAttachment[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すアタッチメントの最大数を設定します。

6.147.2.1. follow
リンクのコピー

6.147.2.2. max
リンクのコピー

返すアタッチメントの最大数を設定します。指定しない場合、すべてのアタッチメントが返されます。

6.148. NetworkFilter
リンクのコピー

ネットワークフィルターを管理します。

<network_filter id="00000019-0019-0019-0019-00000000026b">
  <name>example-network-filter-b</name>
  <version>
    <major>4</major>
    <minor>0</minor>
    <build>-1</build>
    <revision>-1</revision>
  </version>
</network_filter>

<network_filter id="00000019-0019-0019-0019-00000000026b">
  <name>example-network-filter-b</name>
  <version>
    <major>4</major>
    <minor>0</minor>
    <build>-1</build>
    <revision>-1</revision>
  </version>
</network_filter>

Copy to Clipboard

Toggle word wrap

バージョンは、特定のフィルターの最小サポートバージョンを参照することに注意してください。

Expand

表6.448 メソッドの概要
名前	Summary
`get`	ネットワークフィルターの表現を取得します。

6.148.1. get GET
リンクのコピー

ネットワークフィルターの表現を取得します。

Expand

表6.449 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`network_filter`	NetworkFilter	Out

6.148.1.1. follow
リンクのコピー

6.149. NetworkFilters
リンクのコピー

読み取り専用のネットワークフィルターサブコレクションを表します。

ネットワークフィルターを使用すると、定義されたルールに従って、VM の nic との間で送受信されるパケットをフィルター処理できます。詳細は、NetworkFilter サービスドキュメントを参照してください。

ネットワークフィルターは、バージョン 3.0 以降、さまざまなバージョンでサポートされています。

ネットワークフィルターは、vnic プロファイルごとに定義されます。

vnic プロファイルは、特定のネットワークに対して定義されます。

ネットワークは、複数の異なるクラスターに割り当てることができます。将来的には、各ネットワークはクラスターレベルで定義されます。

現在、各ネットワークはデータセンターレベルで定義されています。各ネットワークの潜在的なネットワークフィルターは、ネットワークのデータセンター互換バージョン V によって決定されます。特定のネットワークに対してこのネットワークフィルターを設定するには、V がネットワークフィルターバージョン以上である必要があります。ネットワークフィルターをサポートするバージョンのクラスターにネットワークが割り当てられている場合、データセンターのバージョンがネットワークフィルターのバージョンより小さいため、フィルターを使用できない場合があることに注意してください。

特定のクラスターに対してサポートされているすべてのネットワークフィルターをリスト表示する例:

GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters

GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters

Copy to Clipboard

Toggle word wrap

出力:

<network_filters>
  <network_filter id="00000019-0019-0019-0019-00000000026c">
    <name>example-network-filter-a</name>
    <version>
      <major>4</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
  <network_filter id="00000019-0019-0019-0019-00000000026b">
    <name>example-network-filter-b</name>
    <version>
      <major>4</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
  <network_filter id="00000019-0019-0019-0019-00000000026a">
    <name>example-network-filter-a</name>
    <version>
      <major>3</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
</network_filters>

<network_filters>
  <network_filter id="00000019-0019-0019-0019-00000000026c">
    <name>example-network-filter-a</name>
    <version>
      <major>4</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
  <network_filter id="00000019-0019-0019-0019-00000000026b">
    <name>example-network-filter-b</name>
    <version>
      <major>4</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
  <network_filter id="00000019-0019-0019-0019-00000000026a">
    <name>example-network-filter-a</name>
    <version>
      <major>3</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
</network_filters>

Copy to Clipboard

Toggle word wrap

Expand

表6.450 メソッドの概要
名前	Summary
`list`	ネットワークフィルターの表現を取得します。

6.149.1. list GET
リンクのコピー

ネットワークフィルターの表現を取得します。

返されるネットワークフィルターリストの順序は保証されません。

Expand

表6.451 パラメーターの概要
名前	型	方向	Summary
`filters`	NetworkFilter[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.149.1.1. follow
リンクのコピー

6.150. NetworkLabel
リンクのコピー

Expand

表6.452 メソッドの概要
名前	Summary
`get`
`remove`	論理ネットワークからラベルを削除します。

6.150.1. get GET
リンクのコピー

Expand

表6.453 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`label`	NetworkLabel	Out

6.150.1.1. follow
リンクのコピー

6.150.2. remove DELETE
リンクのコピー

論理ネットワークからラベルを削除します。

たとえば、ID 123 を持つ論理ネットワークからラベル exemplary を削除するには、以下の要求を送信します。

DELETE /ovirt-engine/api/networks/123/networklabels/exemplary

DELETE /ovirt-engine/api/networks/123/networklabels/exemplary

Copy to Clipboard

Toggle word wrap

Expand

表6.454 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.151. NetworkLabels
リンクのコピー

ネットワークまたはホスト NIC にアタッチされたラベルの ser を管理します。

Expand

表6.455 メソッドの概要
名前	Summary
`add`	論理ネットワークにラベルをアタッチします。
`list`	ネットワークまたはホスト NIC にアタッチされたラベルのリストを返します。

6.151.1. add POST
リンクのコピー

論理ネットワークにラベルをアタッチします。

ラベルを論理ネットワークにアタッチして、その論理ネットワークと、同じラベルがアタッチされた物理ホストネットワークインターフェイスとの関連付けを自動化することができます。

たとえば、ラベル mylabel を ID 123 を持つ論理ネットワークにアタッチするには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/networks/123/networklabels

POST /ovirt-engine/api/networks/123/networklabels

Copy to Clipboard

Toggle word wrap

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

<network_label id="mylabel"/>

<network_label id="mylabel"/>

Copy to Clipboard

Toggle word wrap

Expand

表6.456 パラメーターの概要
名前	型	方向	Summary
`label`	NetworkLabel	In/Out

6.151.2. list GET
リンクのコピー

ネットワークまたはホスト NIC にアタッチされたラベルのリストを返します。

返されるラベルリストの順序は保証されません。

Expand

表6.457 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`labels`	NetworkLabel[]	Out
`max`	Integer	In	返すラベルの最大数を設定します。

6.151.2.1. follow
リンクのコピー

6.151.2.2. max
リンクのコピー

返すラベルの最大数を設定します。指定されていない場合、すべてのラベルが返されます。

6.152. Networks
リンクのコピー

論理ネットワークを管理します。

エンジンは、インストール時にデフォルトの ovirtmgmt ネットワークを作成します。このネットワークは、ハイパーバイザーホストにアクセスするための管理ネットワークとして機能します。このネットワークは Default クラスターに関連付けられており、Default データセンターのメンバーです。

Expand

表6.458 メソッドの概要
名前	Summary
`add`	新しい論理ネットワークを作成するか、既存のネットワークをデータセンターに関連付けます。
`list`	論理ネットワークをリスト表示します。

6.152.1. add POST
リンクのコピー

新しい論理ネットワークを作成するか、既存のネットワークをデータセンターに関連付けます。

新しいネットワークの作成には、name 要素と data_center 要素が必要です。

たとえば、データセンター 123 用に mynetwork という名前のネットワークを作成するには、以下のような要求を送信します。

POST /ovirt-engine/api/networks

POST /ovirt-engine/api/networks

Copy to Clipboard

Toggle word wrap

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

<network>
  <name>mynetwork</name>
  <data_center id="123"/>
</network>

<network>
  <name>mynetwork</name>
  <data_center id="123"/>
</network>

Copy to Clipboard

Toggle word wrap

既存のネットワーク 456 をデータセンター 123 に関連付けるには、以下のような要求を送信します。

POST /ovirt-engine/api/datacenters/123/networks

POST /ovirt-engine/api/datacenters/123/networks

Copy to Clipboard

Toggle word wrap

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

<network>
  <name>ovirtmgmt</name>
</network>

<network>
  <name>ovirtmgmt</name>
</network>

Copy to Clipboard

Toggle word wrap

外部 OpenStack ネットワークプロバイダー 456 の上に exnetwork という名前のネットワークを作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/networks

POST /ovirt-engine/api/networks

Copy to Clipboard

Toggle word wrap

<network>
  <name>exnetwork</name>
  <external_provider id="456"/>
  <data_center id="123"/>
</network>

<network>
  <name>exnetwork</name>
  <external_provider id="456"/>
  <data_center id="123"/>
</network>

Copy to Clipboard

Toggle word wrap

Expand

表6.459 パラメーターの概要
名前	型	方向	Summary
`network`	Network	In/Out

6.152.2. list GET
リンクのコピー

論理ネットワークをリスト表示します。

以下に例を示します。

GET /ovirt-engine/api/networks

GET /ovirt-engine/api/networks

Copy to Clipboard

Toggle word wrap

以下を応答します。

<networks>
  <network href="/ovirt-engine/api/networks/123" id="123">
    <name>ovirtmgmt</name>
    <description>Default Management Network</description>
    <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
    <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
    <mtu>0</mtu>
    <stp>false</stp>
    <usages>
      <usage>vm</usage>
    </usages>
    <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
  </network>
  ...
</networks>

<networks>
  <network href="/ovirt-engine/api/networks/123" id="123">
    <name>ovirtmgmt</name>
    <description>Default Management Network</description>
    <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
    <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
    <mtu>0</mtu>
    <stp>false</stp>
    <usages>
      <usage>vm</usage>
    </usages>
    <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
  </network>
  ...
</networks>

Copy to Clipboard

Toggle word wrap

返されるネットワークのリストの順序は、sortby 句が search パラメーターに含まれている場合にのみ保証されます。

Expand

表6.460 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すネットワークの最大数を設定します。
`networks`	Network[]	Out
`search`	String	In	返されたホストを制限するために使用されるクエリー文字列。

6.152.2.1. case_sensitive
リンクのコピー

6.152.2.2. follow
リンクのコピー

6.152.2.3. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

6.153. NicNetworkFilterParameter
リンクのコピー

このサービスは、ネットワークフィルターのパラメーターを管理します。

Expand

表6.461 メソッドの概要
名前	Summary
`get`	ネットワークフィルターパラメーターの表現を取得します。
`remove`	フィルターパラメーターを削除します。
`update`	ネットワークフィルターパラメーターを更新します。

6.153.1. get GET
リンクのコピー

ネットワークフィルターパラメーターの表現を取得します。

Expand

表6.462 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`parameter`	NetworkFilterParameter	Out	ネットワークフィルターパラメーターの表現。

6.153.1.1. follow
リンクのコピー

6.153.2. remove DELETE
リンクのコピー

フィルターパラメーターを削除します。

たとえば、仮想マシン 789 の NIC 456 で ID 123 を持つフィルターパラメーターを削除するには、以下のような要求を送信します。

DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123

DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123

Copy to Clipboard

Toggle word wrap

6.153.3. update PUT
リンクのコピー

ネットワークフィルターパラメーターを更新します。

たとえば、仮想マシン 789 の NIC 456 で ID 123 を持つネットワークフィルターパラメーターを更新するには、以下のような要求を送信します。

PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123

PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123

Copy to Clipboard

Toggle word wrap

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

<network_filter_parameter>
  <name>updatedName</name>
  <value>updatedValue</value>
</network_filter_parameter>

<network_filter_parameter>
  <name>updatedName</name>
  <value>updatedValue</value>
</network_filter_parameter>

Copy to Clipboard

Toggle word wrap

Expand

表6.463 パラメーターの概要
名前	型	方向	Summary
`parameter`	NetworkFilterParameter	In/Out	更新中のネットワークフィルターパラメーター。

6.154. NicNetworkFilterParameters
リンクのコピー

このサービスは、ネットワークフィルターのパラメーターのコレクションを管理します。

Expand

表6.464 メソッドの概要
名前	Summary
`add`	ネットワークフィルターパラメーターを追加します。
`list`	ネットワークフィルターパラメーターの表現を取得します。

6.154.1. add POST
リンクのコピー

ネットワークフィルターパラメーターを追加します。

たとえば、仮想マシン 789 の NIC 456 にネットワークフィルターのパラメーターを追加するには、以下のような要求を送信します。

POST /ovirt-engine/api/vms/789/nics/456/networkfilterparameters

POST /ovirt-engine/api/vms/789/nics/456/networkfilterparameters

Copy to Clipboard

Toggle word wrap

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

<network_filter_parameter>
  <name>IP</name>
  <value>10.0.1.2</value>
</network_filter_parameter>

<network_filter_parameter>
  <name>IP</name>
  <value>10.0.1.2</value>
</network_filter_parameter>

Copy to Clipboard

Toggle word wrap

Expand

表6.465 パラメーターの概要
名前	型	方向	Summary
`parameter`	NetworkFilterParameter	In/Out	追加中のネットワークフィルターパラメーター。

6.154.2. list GET
リンクのコピー

ネットワークフィルターパラメーターの表現を取得します。

返されるネットワークフィルターリストの順序は保証されません。

Expand

表6.466 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`parameters`	NetworkFilterParameter[]	Out	ネットワークフィルターパラメーターのリスト。

6.154.2.1. follow
リンクのコピー

6.155. OpenstackImage
リンクのコピー

Expand

表6.467 メソッドの概要
名前	Summary
`get`
`import`	Glance イメージストレージドメインから仮想マシンをインポートします。

6.155.1. get GET
リンクのコピー

Expand

表6.468 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`image`	OpenstackImage	Out

6.155.1.1. follow
リンクのコピー

6.155.2. import POST
リンクのコピー

Glance イメージストレージドメインから仮想マシンをインポートします。

たとえば、識別子 123 のストレージドメインから識別子 456 のイメージをインポートするには、以下のような要求を送信します。

POST /ovirt-engine/api/openstackimageproviders/123/images/456/import

POST /ovirt-engine/api/openstackimageproviders/123/images/456/import

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain>
    <name>images0</name>
  </storage_domain>
  <cluster>
    <name>images0</name>
  </cluster>
</action>

<action>
  <storage_domain>
    <name>images0</name>
  </storage_domain>
  <cluster>
    <name>images0</name>
  </cluster>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.469 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	インポートを非同期で実行する必要があるかどうかを示します。
`cluster`	クラスター	In	このパラメーターは、`import_as_template` を使用する場合は必須であり、テンプレートとして glance イメージをインポートする際に使用するクラスターを示します。
`disk`	ディスク	In
`import_as_template`	ブール値	In	イメージをテンプレートとしてインポートする必要があるかどうかを示します。
`storage_domain`	StorageDomain	In
`テンプレート`	テンプレート	In

6.156. OpenstackImageProvider
リンクのコピー

Expand

表6.470 メソッドの概要
名前	Summary
`get`
`importcertificates`	外部ホストプロバイダーの SSL 証明書をインポートします。
`remove`
`testconnectivity`	外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。
`update`	システム内の指定された OpenStack イメージプロバイダーを更新します。

6.156.1. get GET
リンクのコピー

Expand

表6.471 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`provider`	OpenStackImageProvider	Out

6.156.1.1. follow
リンクのコピー

6.156.2. importcertificates POST
リンクのコピー

外部ホストプロバイダーの SSL 証明書をインポートします。

Expand

表6.472 パラメーターの概要
名前	型	方向	Summary
`certificates`	Certificate[]	In

6.156.3. remove DELETE
リンクのコピー

Expand

表6.473 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.156.4. testconnectivity POST
リンクのコピー

外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

Copy to Clipboard

Toggle word wrap

Expand

表6.474 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	テストを非同期で実行する必要があるかどうかを示します。

6.156.5. update PUT
リンクのコピー

システム内の指定された OpenStack イメージプロバイダーを更新します。

Expand

表6.475 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`provider`	OpenStackImageProvider	In/Out

6.157. OpenstackImageProviders
リンクのコピー

Expand

表6.476 メソッドの概要
名前	Summary
`add`	新しい OpenStack イメージプロバイダーをシステムに追加します。
`list`	プロバイダーのリストを返します。

6.157.1. add POST
リンクのコピー

新しい OpenStack イメージプロバイダーをシステムに追加します。

Expand

表6.477 パラメーターの概要
名前	型	方向	Summary
`provider`	OpenStackImageProvider	In/Out

6.157.2. list GET
リンクのコピー

プロバイダーのリストを返します。

返されるプロバイダーリストの順序は保証されません。

Expand

表6.478 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロバイダーの最大数を設定します。
`providers`	OpenStackImageProvider[]	Out
`search`	String	In	返される OpenStack イメージプロバイダーを制限するために使用されるクエリー文字列。

6.157.2.1. follow
リンクのコピー

6.157.2.2. max
リンクのコピー

返すプロバイダーの最大数を設定します。指定しない場合は、すべてのプロバイダーが返されます。

6.158. OpenstackImages
リンクのコピー

Expand

表6.479 メソッドの概要
名前	Summary
`list`	Glance イメージストレージドメインのイメージをリスト表示します。

6.158.1. list GET
リンクのコピー

Glance イメージストレージドメインのイメージをリスト表示します。

返されるイメージリストの順序は保証されません。

Expand

表6.480 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`images`	OpenStackImage[]	Out
`max`	Integer	In	返すイメージの最大数を設定します。

6.158.1.1. follow
リンクのコピー

6.158.1.2. max
リンクのコピー

返すイメージの最大数を設定します。指定しない場合、すべてのイメージが返されます。

6.159. OpenstackNetwork
リンクのコピー

Expand

表6.481 メソッドの概要
名前	Summary
`get`
`import`	この操作は、外部ネットワークを Red Hat Virtualization にインポートします。

6.159.1. get GET
リンクのコピー

Expand

表6.482 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`network`	OpenStackNetwork	Out

6.159.1.1. follow
リンクのコピー

6.159.2. import POST
リンクのコピー

この操作は、外部ネットワークを Red Hat Virtualization にインポートします。指定したデータセンターにネットワークが追加されます。

Expand

表6.483 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	インポートを非同期で実行する必要があるかどうかを示します。
`data_center`	DataCenter	In	ネットワークのインポート先のデータセンター。

6.159.2.1. data_center
リンクのコピー

ネットワークのインポート先のデータセンター。データセンターは必須であり、id または name 属性を使用して指定できます。残りの属性は無視されます。

注記

プロバイダーで auto_sync が有効になっている場合、ネットワークが自動的にインポートされる可能性があります。これを防ぐには、auto_sync を false に設定して自動インポートを無効にし、ネットワークのインポート後に再度有効にすることができます。

6.160. OpenstackNetworkProvider
リンクのコピー

このサービスは、OpenStack ネットワークプロバイダーを管理します。

Expand

表6.484 メソッドの概要
名前	Summary
`get`	このサービスによって管理されるオブジェクトの表現を返します。
`importcertificates`	外部ホストプロバイダーの SSL 証明書をインポートします。
`remove`	プロバイダーを削除します。
`testconnectivity`	外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。
`update`	プロバイダーを更新します。

6.160.1. get GET
リンクのコピー

このサービスによって管理されるオブジェクトの表現を返します。

たとえば、識別子が 1234 の OpenStack ネットワークプロバイダーを取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/openstacknetworkproviders/1234

GET /ovirt-engine/api/openstacknetworkproviders/1234

Copy to Clipboard

Toggle word wrap

Expand

表6.485 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`provider`	OpenStackNetworkProvider	Out

6.160.1.1. follow
リンクのコピー

6.160.2. importcertificates POST
リンクのコピー

外部ホストプロバイダーの SSL 証明書をインポートします。

Expand

表6.486 パラメーターの概要
名前	型	方向	Summary
`certificates`	Certificate[]	In

6.160.3. remove DELETE
リンクのコピー

プロバイダーを削除します。

たとえば、識別子が 1234 の OpenStack ネットワークプロバイダーを削除するには、以下のようなリクエストを送信します。

DELETE /ovirt-engine/api/openstacknetworkproviders/1234

DELETE /ovirt-engine/api/openstacknetworkproviders/1234

Copy to Clipboard

Toggle word wrap

Expand

表6.487 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.160.4. testconnectivity POST
リンクのコピー

外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

Copy to Clipboard

Toggle word wrap

Expand

表6.488 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	テストを非同期で実行する必要があるかどうかを示します。

6.160.5. update PUT
リンクのコピー

プロバイダーを更新します。

たとえば、識別子 1234 を持つ OpenStack ネットワークプロバイダーの provider_name、requires_authentication、url、tenant_name、および type プロパティーを更新するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/openstacknetworkproviders/1234

PUT /ovirt-engine/api/openstacknetworkproviders/1234

Copy to Clipboard

Toggle word wrap

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

<openstack_network_provider>
  <name>ovn-network-provider</name>
  <requires_authentication>false</requires_authentication>
  <url>http://some_server_url.domain.com:9696</url>
  <tenant_name>oVirt</tenant_name>
  <type>external</type>
</openstack_network_provider>

<openstack_network_provider>
  <name>ovn-network-provider</name>
  <requires_authentication>false</requires_authentication>
  <url>http://some_server_url.domain.com:9696</url>
  <tenant_name>oVirt</tenant_name>
  <type>external</type>
</openstack_network_provider>

Copy to Clipboard

Toggle word wrap

Expand

表6.489 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`provider`	OpenStackNetworkProvider	In/Out	更新するプロバイダー。

6.161. OpenstackNetworkProviders
リンクのコピー

このサービスは、OpenStack ネットワークプロバイダーを管理します。

Expand

表6.490 メソッドの概要
名前	Summary
`add`	この操作により、新しいネットワークプロバイダーがシステムに追加されます。
`list`	プロバイダーのリストを返します。

6.161.1. add POST
リンクのコピー

この操作により、新しいネットワークプロバイダーがシステムに追加されます。type プロパティーが存在しない場合、デフォルト値の NEUTRON が使用されます。

Expand

表6.491 パラメーターの概要
名前	型	方向	Summary
`provider`	OpenStackNetworkProvider	In/Out

6.161.2. list GET
リンクのコピー

プロバイダーのリストを返します。

返されるプロバイダーリストの順序は保証されません。

Expand

表6.492 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロバイダーの最大数を設定します。
`providers`	OpenStackNetworkProvider[]	Out
`search`	String	In	返される OpenStack ネットワークプロバイダーを制限するために使用されるクエリー文字列。

6.161.2.1. follow
リンクのコピー

6.161.2.2. max
リンクのコピー

返すプロバイダーの最大数を設定します。指定しない場合は、すべてのプロバイダーが返されます。

6.162. OpenstackNetworks
リンクのコピー

Expand

表6.493 メソッドの概要
名前	Summary
`list`	ネットワークのリストを返します。

6.162.1. list GET
リンクのコピー

ネットワークのリストを返します。

返されるネットワークリストの順序は保証されません。

Expand

表6.494 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すネットワークの最大数を設定します。
`networks`	OpenStackNetwork[]	Out

6.162.1.1. follow
リンクのコピー

6.162.1.2. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

6.163. OpenstackSubnet
リンクのコピー

Expand

表6.495 メソッドの概要
名前	Summary
`get`
`remove`

6.163.1. get GET
リンクのコピー

Expand

表6.496 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`subnet`	OpenStackSubnet	Out

6.163.1.1. follow
リンクのコピー

6.163.2. remove DELETE
リンクのコピー

Expand

表6.497 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.164. OpenstackSubnets
リンクのコピー

Expand

表6.498 メソッドの概要
名前	Summary
`add`
`list`	サブネットワークのリストを返します。

6.164.1. add POST
リンクのコピー

Expand

表6.499 パラメーターの概要
名前	型	方向	Summary
`subnet`	OpenStackSubnet	In/Out

6.164.2. list GET
リンクのコピー

サブネットワークのリストを返します。

返されるサブネットワークリストの順序は保証されません。

Expand

表6.500 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すサブネットワークの最大数を設定します。
`subnets`	OpenStackSubnet[]	Out

6.164.2.1. follow
リンクのコピー

6.164.2.2. max
リンクのコピー

返すサブネットワークの最大数を設定します。指定されていない場合には、すべてのサブネットワークが返されます。

6.165. OpenstackVolumeAuthenticationKey
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表6.501 メソッドの概要
名前	Summary
`get`
`remove`
`update`	指定された認証キーを更新します。

6.165.1. get GET
リンクのコピー

Expand

表6.502 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`key`	OpenstackVolumeAuthenticationKey	Out

6.165.1.1. follow
リンクのコピー

6.165.2. remove DELETE
リンクのコピー

Expand

表6.503 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.165.3. update PUT
リンクのコピー

指定された認証キーを更新します。

Expand

表6.504 パラメーターの概要
名前	型	方向	Summary
`key`	OpenstackVolumeAuthenticationKey	In/Out

6.166. OpenstackVolumeAuthenticationKeys
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表6.505 メソッドの概要
名前	Summary
`add`	OpenStack ボリュームプロバイダーに新しい認証キーを追加します。
`list`	認証キーのリストを返します。

6.166.1. add POST
リンクのコピー

OpenStack ボリュームプロバイダーに新しい認証キーを追加します。

Expand

表6.506 パラメーターの概要
名前	型	方向	Summary
`key`	OpenstackVolumeAuthenticationKey	In/Out

6.166.2. list GET
リンクのコピー

認証キーのリストを返します。

返される認証キーリストの順序は保証されません。

Expand

表6.507 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`keys`	OpenstackVolumeAuthenticationKey[]	Out
`max`	Integer	In	返すことのできるキーの最大数。

6.166.2.1. follow
リンクのコピー

6.166.2.2. max
リンクのコピー

返すことのできるキーの最大数。指定されていない場合は、すべてのキーが返されます。

6.167. OpenstackVolumeProvider
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表6.508 メソッドの概要
名前	Summary
`get`
`importcertificates`	外部ホストプロバイダーの SSL 証明書をインポートします。
`remove`
`testconnectivity`	外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。
`update`	システム内の指定された OpenStack ボリュームプロバイダーを更新します。

6.167.1. get GET
リンクのコピー

Expand

表6.509 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`provider`	OpenStackVolumeProvider	Out

6.167.1.1. follow
リンクのコピー

6.167.2. importcertificates POST
リンクのコピー

外部ホストプロバイダーの SSL 証明書をインポートします。

Expand

表6.510 パラメーターの概要
名前	型	方向	Summary
`certificates`	Certificate[]	In

6.167.3. remove DELETE
リンクのコピー

Expand

表6.511 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。
`force`	ブール値	In	操作中に何らかの障害が発生した場合でも、操作が成功し、プロバイダーがデータベースから削除されるかどうかを示します。

6.167.3.1. force
リンクのコピー

操作中に何らかの障害が発生した場合でも、操作が成功し、プロバイダーがデータベースから削除されるかどうかを示します。

このパラメーターはオプションであり、デフォルト値は false です。

6.167.4. testconnectivity POST
リンクのコピー

外部プロバイダーの接続をテストするには、123 がプロバイダーの ID である次の要求を実行する必要があります。

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

POST /ovirt-engine/api/externalhostproviders/123/testconnectivity

Copy to Clipboard

Toggle word wrap

Expand

表6.512 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	テストを非同期で実行する必要があるかどうかを示します。

6.167.5. update PUT
リンクのコピー

システム内の指定された OpenStack ボリュームプロバイダーを更新します。

Expand

表6.513 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`provider`	OpenStackVolumeProvider	In/Out

6.168. OpenstackVolumeProviders
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表6.514 メソッドの概要
名前	Summary
`add`	新しいボリュームプロバイダーを追加します。
`list`	ボリュームプロバイダーのリストを取得します。

6.168.1. add POST
リンクのコピー

新しいボリュームプロバイダーを追加します。

以下に例を示します。

POST /ovirt-engine/api/openstackvolumeproviders

POST /ovirt-engine/api/openstackvolumeproviders

Copy to Clipboard

Toggle word wrap

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

<openstack_volume_provider>
  <name>mycinder</name>
  <url>https://mycinder.example.com:8776</url>
  <data_center>
    <name>mydc</name>
  </data_center>
  <requires_authentication>true</requires_authentication>
  <username>admin</username>
  <password>mypassword</password>
  <tenant_name>mytenant</tenant_name>
</openstack_volume_provider>

<openstack_volume_provider>
  <name>mycinder</name>
  <url>https://mycinder.example.com:8776</url>
  <data_center>
    <name>mydc</name>
  </data_center>
  <requires_authentication>true</requires_authentication>
  <username>admin</username>
  <password>mypassword</password>
  <tenant_name>mytenant</tenant_name>
</openstack_volume_provider>

Copy to Clipboard

Toggle word wrap

Expand

表6.515 パラメーターの概要
名前	型	方向	Summary
`provider`	OpenStackVolumeProvider	In/Out

6.168.2. list GET
リンクのコピー

ボリュームプロバイダーのリストを取得します。

返されるボリュームプロバイダーリストの順序は保証されません。

Expand

表6.516 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロバイダーの最大数を設定します。
`providers`	OpenStackVolumeProvider[]	Out
`search`	String	In	返されたボリュームプロバイダーを制限するために使用されるクエリー文字列です。

6.168.2.1. follow
リンクのコピー

6.168.2.2. max
リンクのコピー

返すプロバイダーの最大数を設定します。指定しない場合は、すべてのプロバイダーが返されます。

6.169. OpenstackVolumeType
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表6.517 メソッドの概要
名前	Summary
`get`

6.169.1. get GET
リンクのコピー

Expand

表6.518 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`type`	OpenStackVolumeType	Out

6.169.1.1. follow
リンクのコピー

6.170. OpenstackVolumeTypes
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表6.519 メソッドの概要
名前	Summary
`list`	ボリュームタイプのリストを返します。

6.170.1. list GET
リンクのコピー

ボリュームタイプのリストを返します。

返されるボリュームタイプリストの順序は保証されません。

Expand

表6.520 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すボリュームタイプの最大数を設定します。
`types`	OpenStackVolumeType[]	Out

6.170.1.1. follow
リンクのコピー

6.170.1.2. max
リンクのコピー

返すボリュームタイプの最大数を設定します。指定されていない場合は、すべてのボリュームタイプが返されます。

6.171. OperatingSystem
リンクのコピー

Expand

表6.521 メソッドの概要
名前	Summary
`get`

6.171.1. get GET
リンクのコピー

Expand

表6.522 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`operating_system`	OperatingSystemInfo	Out

6.171.1.1. follow
リンクのコピー

6.172. OperatingSystems
リンクのコピー

システムで使用可能なオペレーティングシステムのタイプのセットを管理します。

Expand

表6.523 メソッドの概要
名前	Summary
`list`	システムで利用可能なオペレーティングシステムのタイプのリストを返します。

6.172.1. list GET
リンクのコピー

システムで利用可能なオペレーティングシステムのタイプのリストを返します。

返されるオペレーティングシステムリストの順序は保証されません。

Expand

表6.524 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すネットワークの最大数を設定します。
`operating_system`	OperatingSystemInfo[]	Out

6.172.1.1. follow
リンクのコピー

6.172.1.2. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

6.173. Permission
リンクのコピー

Expand

表6.525 メソッドの概要
名前	Summary
`get`
`remove`

6.173.1. get GET
リンクのコピー

Expand

表6.526 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`permission`	Permission	Out

6.173.1.1. follow
リンクのコピー

6.173.2. remove DELETE
リンクのコピー

Expand

表6.527 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.174. Permit
リンクのコピー

ロールの特定の permit を管理するサービス。

Expand

表6.528 メソッドの概要
名前	Summary
`get`	ロールの permit に関する情報を取得します。
`remove`	ロールから permit を削除します。

6.174.1. get GET
リンクのコピー

ロールの permit に関する情報を取得します。

たとえば、ID 123 のロールの ID 456 の permit に関する情報を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/roles/123/permits/456

GET /ovirt-engine/api/roles/123/permits/456

Copy to Clipboard

Toggle word wrap

<permit href="/ovirt-engine/api/roles/123/permits/456" id="456">
  <name>change_vm_cd</name>
  <administrative>false</administrative>
  <role href="/ovirt-engine/api/roles/123" id="123"/>
</permit>

<permit href="/ovirt-engine/api/roles/123/permits/456" id="456">
  <name>change_vm_cd</name>
  <administrative>false</administrative>
  <role href="/ovirt-engine/api/roles/123" id="123"/>
</permit>

Copy to Clipboard

Toggle word wrap

Expand

表6.529 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`permit`	Permit	Out	ロールの permit。

6.174.1.1. follow
リンクのコピー

6.174.2. remove DELETE
リンクのコピー

ロールから permit を削除します。

たとえば、ID 123 のロールから ID 456 の permit を削除するには、以下のようなリクエストを送信します。

DELETE /ovirt-engine/api/roles/123/permits/456

DELETE /ovirt-engine/api/roles/123/permits/456

Copy to Clipboard

Toggle word wrap

Expand

表6.530 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.175. Permits
リンクのコピー

特定のロールの permits サブコレクションを表します。

Expand

表6.531 メソッドの概要
名前	Summary
`add`	ロールに permit を追加します。
`list`	ロールの permits をリスト表示します。

6.175.1. add POST
リンクのコピー

ロールに permit を追加します。permit 名は、cluster_levels サービスから取得できます。

たとえば、ID 123 のロールに permit create_vm を割り当てるには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/roles/123/permits

POST /ovirt-engine/api/roles/123/permits

Copy to Clipboard

Toggle word wrap

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

<permit>
  <name>create_vm</name>
</permit>

<permit>
  <name>create_vm</name>
</permit>

Copy to Clipboard

Toggle word wrap

Expand

表6.532 パラメーターの概要
名前	型	方向	Summary
`permit`	Permit	In/Out	追加する permit。

6.175.2. list GET
リンクのコピー

ロールの permits をリスト表示します。

たとえば、ID 123 のロールの permits をリスト表示するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/roles/123/permits

GET /ovirt-engine/api/roles/123/permits

Copy to Clipboard

Toggle word wrap

<permits>
  <permit href="/ovirt-engine/api/roles/123/permits/5" id="5">
    <name>change_vm_cd</name>
    <administrative>false</administrative>
    <role href="/ovirt-engine/api/roles/123" id="123"/>
  </permit>
  <permit href="/ovirt-engine/api/roles/123/permits/7" id="7">
    <name>connect_to_vm</name>
    <administrative>false</administrative>
    <role href="/ovirt-engine/api/roles/123" id="123"/>
  </permit>
</permits>

<permits>
  <permit href="/ovirt-engine/api/roles/123/permits/5" id="5">
    <name>change_vm_cd</name>
    <administrative>false</administrative>
    <role href="/ovirt-engine/api/roles/123" id="123"/>
  </permit>
  <permit href="/ovirt-engine/api/roles/123/permits/7" id="7">
    <name>connect_to_vm</name>
    <administrative>false</administrative>
    <role href="/ovirt-engine/api/roles/123" id="123"/>
  </permit>
</permits>

Copy to Clipboard

Toggle word wrap

返される permits リストの順序は保証されません。

Expand

表6.533 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す permits の最大数を設定します。
`permits`	Permit[]	Out	permits のリスト。

6.175.2.1. follow
リンクのコピー

6.175.2.2. max
リンクのコピー

返す permits の最大数を設定します。指定されていない場合は、すべての permits が返されます。

6.176. Qos
リンクのコピー

Expand

表6.534 メソッドの概要
名前	Summary
`get`	データセンターで指定された QoS を取得します。
`remove`	データセンターから指定された QoS を削除します。
`update`	データセンターで指定された QoS を更新します。

6.176.1. get GET
リンクのコピー

データセンターで指定された QoS を取得します。

GET /ovirt-engine/api/datacenters/123/qoss/123

GET /ovirt-engine/api/datacenters/123/qoss/123

Copy to Clipboard

Toggle word wrap

以下のような応答が得られます。

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>123</name>
  <description>123</description>
  <max_iops>1</max_iops>
  <max_throughput>1</max_throughput>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>123</name>
  <description>123</description>
  <max_iops>1</max_iops>
  <max_throughput>1</max_throughput>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>

Copy to Clipboard

Toggle word wrap

Expand

表6.535 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`qos`	Qos	Out	クエリーされた QoS オブジェクト。

6.176.1.1. follow
リンクのコピー

6.176.2. remove DELETE
リンクのコピー

データセンターから指定された QoS を削除します。

DELETE /ovirt-engine/api/datacenters/123/qoss/123

DELETE /ovirt-engine/api/datacenters/123/qoss/123

Copy to Clipboard

Toggle word wrap

Expand

表6.536 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.176.3. update PUT
リンクのコピー

データセンターで指定された QoS を更新します。

PUT /ovirt-engine/api/datacenters/123/qoss/123

PUT /ovirt-engine/api/datacenters/123/qoss/123

Copy to Clipboard

Toggle word wrap

curl の例:

curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \
"<qos><name>321</name><description>321</description><max_iops>10</max_iops></qos>" \
https://engine/ovirt-engine/api/datacenters/123/qoss/123

curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \
"<qos><name>321</name><description>321</description><max_iops>10</max_iops></qos>" \
https://engine/ovirt-engine/api/datacenters/123/qoss/123

Copy to Clipboard

Toggle word wrap

次のような応答が返されます。

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>321</name>
  <description>321</description>
  <max_iops>10</max_iops>
  <max_throughput>1</max_throughput>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>321</name>
  <description>321</description>
  <max_iops>10</max_iops>
  <max_throughput>1</max_throughput>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>

Copy to Clipboard

Toggle word wrap

Expand

表6.537 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`qos`	Qos	In/Out	更新された QoS オブジェクト。

6.177. Qoss
リンクのコピー

データセンターで利用可能な一連の サービス品質 設定を管理します。

Expand

表6.538 メソッドの概要
名前	Summary
`add`	dataCenter に新しい QoS を追加します。
`list`	データセンターで利用可能なサービス品質設定のリストを返します。

6.177.1. add POST
リンクのコピー

dataCenter に新しい QoS を追加します。

POST /ovirt-engine/api/datacenters/123/qoss

POST /ovirt-engine/api/datacenters/123/qoss

Copy to Clipboard

Toggle word wrap

応答は次のようになります。

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>123</name>
  <description>123</description>
  <max_iops>10</max_iops>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>

<qos href="/ovirt-engine/api/datacenters/123/qoss/123" id="123">
  <name>123</name>
  <description>123</description>
  <max_iops>10</max_iops>
  <type>storage</type>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
</qos>

Copy to Clipboard

Toggle word wrap

Expand

表6.539 パラメーターの概要
名前	型	方向	Summary
`qos`	Qos	In/Out	QoS オブジェクトが追加されました。

6.177.2. list GET
リンクのコピー

データセンターで利用可能な サービス品質 設定のリストを返します。

GET /ovirt-engine/api/datacenter/123/qoss

GET /ovirt-engine/api/datacenter/123/qoss

Copy to Clipboard

Toggle word wrap

次のような応答が返されます。

<qoss>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/1" id="1">...</qos>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/2" id="2">...</qos>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/3" id="3">...</qos>
</qoss>

<qoss>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/1" id="1">...</qos>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/2" id="2">...</qos>
  <qos href="/ovirt-engine/api/datacenters/123/qoss/3" id="3">...</qos>
</qoss>

Copy to Clipboard

Toggle word wrap

返されるサービス品質設定のリストは保証されません。

Expand

表6.540 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す QoS 記述子の最大数を設定します。
`qoss`	Qos[]	Out	クエリーされた QoS オブジェクトのリスト。

6.177.2.1. follow
リンクのコピー

6.177.2.2. max
リンクのコピー

返す QoS 記述子の最大数を設定します。指定されていない場合は、すべての記述子が返されます。

6.178. クォータ
リンクのコピー

Expand

表6.541 メソッドの概要
名前	Summary
`get`	クォータを取得します。
`remove`	クォータを削除します。
`update`	クォータを更新します。

6.178.1. get GET
リンクのコピー

クォータを取得します。

クォータを取得する例:

GET /ovirt-engine/api/datacenters/123/quotas/456

GET /ovirt-engine/api/datacenters/123/quotas/456

Copy to Clipboard

Toggle word wrap

<quota id="456">
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
  <cluster_hard_limit_pct>20</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>80</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>

<quota id="456">
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
  <cluster_hard_limit_pct>20</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>80</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>

Copy to Clipboard

Toggle word wrap

Expand

表6.542 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`quota`	クォータ	Out

6.178.1.1. follow
リンクのコピー

6.178.2. remove DELETE
リンクのコピー

クォータを削除します。

クォータを削除する例:

DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321
-0472718ab224 HTTP/1.1
Accept: application/xml
Content-type: application/xml

DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321
-0472718ab224 HTTP/1.1
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

Expand

表6.543 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.178.3. update PUT
リンクのコピー

クォータを更新します。

クォータを更新する例:

PUT /ovirt-engine/api/datacenters/123/quotas/456

PUT /ovirt-engine/api/datacenters/123/quotas/456

Copy to Clipboard

Toggle word wrap

<quota>
  <cluster_hard_limit_pct>30</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>70</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>

<quota>
  <cluster_hard_limit_pct>30</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>70</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>

Copy to Clipboard

Toggle word wrap

Expand

表6.544 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`quota`	クォータ	In/Out

6.179. QuotaClusterLimit
リンクのコピー

Expand

表6.545 メソッドの概要
名前	Summary
`get`
`remove`

6.179.1. get GET
リンクのコピー

Expand

表6.546 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`limit`	QuotaClusterLimit	Out

6.179.1.1. follow
リンクのコピー

6.179.2. remove DELETE
リンクのコピー

Expand

表6.547 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.180. QuotaClusterLimits
リンクのコピー

クラスター用に設定されたクォータ制限のセットを管理します。

Expand

表6.548 メソッドの概要
名前	Summary
`add`	指定された Quota にクラスター制限を追加します。
`list`	クラスターに設定されたクォータ制限のセットを返します。

6.180.1. add POST
リンクのコピー

指定された Quota にクラスター制限を追加します。

Expand

表6.549 パラメーターの概要
名前	型	方向	Summary
`limit`	QuotaClusterLimit	In/Out

6.180.2. list GET
リンクのコピー

クラスターに設定されたクォータ制限のセットを返します。

返されるクォータ制限のリストは保証されません。

Expand

表6.550 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`limits`	QuotaClusterLimit[]	Out
`max`	Integer	In	返す制限の最大数を設定します。

6.180.2.1. follow
リンクのコピー

6.180.2.2. max
リンクのコピー

返す制限の最大数を設定します。指定されていない場合は、すべての制限が返されます。

6.181. QuotaStorageLimit
リンクのコピー

Expand

表6.551 メソッドの概要
名前	Summary
`get`
`remove`

6.181.1. get GET
リンクのコピー

Expand

表6.552 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`limit`	QuotaStorageLimit	Out

6.181.1.1. follow
リンクのコピー

6.181.2. remove DELETE
リンクのコピー

Expand

表6.553 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。

6.182. QuotaStorageLimits
リンクのコピー

クォータ用に設定された一連のストレージ制限を管理します。

Expand

表6.554 メソッドの概要
名前	Summary
`add`	指定されたクォータにストレージ制限を追加します。
`list`	クォータ用に設定されたストレージ制限のリストを返します。

6.182.1. add POST
リンクのコピー

指定されたクォータにストレージ制限を追加します。

データセンター内のすべてのストレージドメインに対して 100 GiB のストレージ制限を作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits

POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits

Copy to Clipboard

Toggle word wrap

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

<quota_storage_limit>
  <limit>100</limit>
</quota_storage_limit>

<quota_storage_limit>
  <limit>100</limit>
</quota_storage_limit>

Copy to Clipboard

Toggle word wrap

ID 000 のストレージドメインに 50GiB のストレージ制限を作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits

POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits

Copy to Clipboard

Toggle word wrap

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

<quota_storage_limit>
  <limit>50</limit>
  <storage_domain id="000"/>
</quota_storage_limit>

<quota_storage_limit>
  <limit>50</limit>
  <storage_domain id="000"/>
</quota_storage_limit>

Copy to Clipboard

Toggle word wrap

Expand

表6.555 パラメーターの概要
名前	型	方向	Summary
`limit`	QuotaStorageLimit	In/Out

6.182.2. list GET
リンクのコピー

クォータ用に設定されたストレージ制限のリストを返します。

返されるストレージ制限リストの順序は保証されません。

Expand

表6.556 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`limits`	QuotaStorageLimit[]	Out
`max`	Integer	In	返す制限の最大数を設定します。

6.182.2.1. follow
リンクのコピー

6.182.2.2. max
リンクのコピー

返す制限の最大数を設定します。指定されていない場合は、すべての制限が返されます。

6.183. Quotas
リンクのコピー

データセンター用に設定された一連のクォータを管理します。

Expand

表6.557 メソッドの概要
名前	Summary
`add`	新しいクォータを作成します。
`list`	データセンターのクォータをリスト表示します。

6.183.1. add POST
リンクのコピー

新しいクォータを作成します。

新しいクォータを作成する例:

POST /ovirt-engine/api/datacenters/123/quotas

POST /ovirt-engine/api/datacenters/123/quotas

Copy to Clipboard

Toggle word wrap

<quota>
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
</quota>

<quota>
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
</quota>

Copy to Clipboard

Toggle word wrap

Expand

表6.558 パラメーターの概要
名前	型	方向	Summary
`quota`	クォータ	In/Out

6.183.2. list GET
リンクのコピー

データセンターのクォータをリスト表示します。

返されるクォータリストの順序は保証されません。

Expand

表6.559 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すクォータ記述子の最大数を設定します。
`quotas`	Quota[]	Out

6.183.2.1. follow
リンクのコピー

6.183.2.2. max
リンクのコピー

返すクォータ記述子の最大数を設定します。指定されていない場合は、すべての記述子が返されます。

6.184. ロール
リンクのコピー

Expand

表6.560 メソッドの概要
名前	Summary
`get`	ロールを取得します。
`remove`	ロールを削除します。
`update`	ロールを更新します。

6.184.1. get GET
リンクのコピー

ロールを取得します。

GET /ovirt-engine/api/roles/123

GET /ovirt-engine/api/roles/123

Copy to Clipboard

Toggle word wrap

以下のような XML 応答を受け取ります。

<role id="123">
  <name>MyRole</name>
  <description>MyRole description</description>
  <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
  <administrative>true</administrative>
  <mutable>false</mutable>
</role>

<role id="123">
  <name>MyRole</name>
  <description>MyRole description</description>
  <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
  <administrative>true</administrative>
  <mutable>false</mutable>
</role>

Copy to Clipboard

Toggle word wrap

Expand

表6.561 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`role`	ロール	Out	ロールを取得しました。

6.184.1.1. follow
リンクのコピー

6.184.2. remove DELETE
リンクのコピー

ロールを削除します。

ロールを削除するには、その ID を知る必要があります。以下のようにリクエストを送信します。

DELETE /ovirt-engine/api/roles/{role_id}

DELETE /ovirt-engine/api/roles/{role_id}

Copy to Clipboard

Toggle word wrap

Expand

表6.562 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.184.3. update PUT
リンクのコピー

ロールを更新します。ロールの作成後に、name、description、および administrative 属性を更新できます。このエンドポイント内では、ロールの permits を管理するサービスを使用するために、必要なロールの permits を追加または削除することはできません。

たとえば、ロールの name、description、および administrative 属性を更新するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/roles/123

PUT /ovirt-engine/api/roles/123

Copy to Clipboard

Toggle word wrap

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

<role>
  <name>MyNewRoleName</name>
  <description>My new description of the role</description>
  <administrative>true</administrative>
</group>

<role>
  <name>MyNewRoleName</name>
  <description>My new description of the role</description>
  <administrative>true</administrative>
</group>

Copy to Clipboard

Toggle word wrap

Expand

表6.563 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`role`	ロール	In/Out	ロールを更新しました。

6.185. ロール
リンクのコピー

ロールのグローバルセットへの読み取り専用アクセスを提供します。

Expand

表6.564 メソッドの概要
名前	Summary
`add`	新規ロールを作成します。
`list`	ロールをリスト表示します。

6.185.1. add POST
リンクのコピー

新規ロールを作成します。ロールは、管理者または非管理者であることができ、異なる permits を持つことができます。

たとえば、ログインして仮想マシンを作成する permits を持つ MyRole 非管理ロールを追加するには、以下のようなリクエストを送信します (permit ID を渡す必要があることに注意してください)。

POST /ovirt-engine/api/roles

POST /ovirt-engine/api/roles

Copy to Clipboard

Toggle word wrap

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

<role>
  <name>MyRole</name>
  <description>My custom role to create virtual machines</description>
  <administrative>false</administrative>
  <permits>
    <permit id="1"/>
    <permit id="1300"/>
  </permits>
</group>

<role>
  <name>MyRole</name>
  <description>My custom role to create virtual machines</description>
  <administrative>false</administrative>
  <permits>
    <permit id="1"/>
    <permit id="1300"/>
  </permits>
</group>

Copy to Clipboard

Toggle word wrap

Expand

表6.565 パラメーターの概要
名前	型	方向	Summary
`role`	ロール	In/Out	追加されるロール。

6.185.2. list GET
リンクのコピー

ロールをリスト表示します。

GET /ovirt-engine/api/roles

GET /ovirt-engine/api/roles

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<roles>
  <role id="123">
     <name>SuperUser</name>
     <description>Roles management administrator</description>
     <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
     <administrative>true</administrative>
     <mutable>false</mutable>
  </role>
  ...
</roles>

<roles>
  <role id="123">
     <name>SuperUser</name>
     <description>Roles management administrator</description>
     <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
     <administrative>true</administrative>
     <mutable>false</mutable>
  </role>
  ...
</roles>

Copy to Clipboard

Toggle word wrap

返されるロールリストの順序は保証されません。

Expand

表6.566 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すロールの最大数を設定します。
`roles`	Role[]	Out	ロールのリストを取得しました。

6.185.2.1. follow
リンクのコピー

6.185.2.2. max
リンクのコピー

返すロールの最大数を設定します。指定のない場合は、すべてのロールが返されます。

6.186. SchedulingPolicies
リンクのコピー

システムで利用可能な一連のスケジューリングポリシーを管理します。

Expand

表6.567 メソッドの概要
名前	Summary
`add`	新しいスケジューリングポリシーをシステムに追加します。
`list`	システムで利用可能なスケジューリングポリシーのリストを返します。

6.186.1. add POST
リンクのコピー

新しいスケジューリングポリシーをシステムに追加します。

Expand

表6.568 パラメーターの概要
名前	型	方向	Summary
`policy`	SchedulingPolicy	In/Out

6.186.2. list GET
リンクのコピー

システムで利用可能なスケジューリングポリシーのリストを返します。

返されるスケジューリングポリシーリストの順序は保証されません。

Expand

表6.569 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すポリシーの最大数を設定します。
`policies`	SchedulingPolicy[]	Out

6.186.2.1. follow
リンクのコピー

6.186.2.2. max
リンクのコピー

返すポリシーの最大数を設定します。指定されていない場合は、すべてのポリシーが返されます。

6.187. SchedulingPolicy
リンクのコピー

Expand

表6.570 メソッドの概要
名前	Summary
`get`
`remove`
`update`	システム内の指定されたユーザー定義のスケジューリングポリシーを更新します。

6.187.1. get GET
リンクのコピー

Expand

表6.571 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`policy`	SchedulingPolicy	Out

6.187.1.1. follow
リンクのコピー

6.187.2. remove DELETE
リンクのコピー

Expand

表6.572 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.187.3. update PUT
リンクのコピー

システム内の指定されたユーザー定義のスケジューリングポリシーを更新します。

Expand

表6.573 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`policy`	SchedulingPolicy	In/Out

6.188. SchedulingPolicyUnit
リンクのコピー

Expand

表6.574 メソッドの概要
名前	Summary
`get`
`remove`

6.188.1. get GET
リンクのコピー

Expand

表6.575 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`unit`	SchedulingPolicyUnit	Out

6.188.1.1. follow
リンクのコピー

6.188.2. remove DELETE
リンクのコピー

Expand

表6.576 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.189. SchedulingPolicyUnits
リンクのコピー

システムで利用可能なスケジューリングポリシーユニットのセットを管理します。

Expand

表6.577 メソッドの概要
名前	Summary
`list`	システムで利用可能なスケジューリングポリシーユニットのリストを返します。

6.189.1. list GET
リンクのコピー

システムで利用可能なスケジューリングポリシーユニットのリストを返します。

返されるスケジューリングポリシーユニットリストの順序は保証されません。

Expand

表6.578 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すポリシーユニットの最大数を設定します。
`units`	SchedulingPolicyUnit[]	Out

6.189.1.1. follow
リンクのコピー

6.189.1.2. max
リンクのコピー

返すポリシーユニットの最大数を設定します。指定されていない場合は、すべてのポリシーユニットが返されます。

6.190. スナップショット
リンクのコピー

Expand

表6.579 メソッドの概要
名前	Summary
`get`
`remove`
`restore`	仮想マシンのスナップショットを復元します。

6.190.1. get GET
リンクのコピー

Expand

表6.580 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`snapshot`	スナップショット	Out

6.190.1.1. follow
リンクのコピー

6.190.2. remove DELETE
リンクのコピー

Expand

表6.581 パラメーターの概要
名前	型	方向	Summary
`all_content`	ブール値	In	仮想マシンのスナップショットのすべての属性を応答に含める必要があるかどうかを示します。
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.190.2.1. all_content
リンクのコピー

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

デフォルトでは、属性 initialization.configuration.data は除外されています。

たとえば、ID 123 の仮想マシンの ID 456 のスナップショットの完全な表現を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true

GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true

Copy to Clipboard

Toggle word wrap

6.190.3. restore POST
リンクのコピー

仮想マシンのスナップショットを復元します。

たとえば、識別子が 123 の仮想マシンの識別子が 456 のスナップショットを復元するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/snapshots/456/restore

POST /ovirt-engine/api/vms/123/snapshots/456/restore

Copy to Clipboard

Toggle word wrap

ボディに空の action がある場合:

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

注記

仮想マシンを実行する前に、コミット操作が完了し、仮想マシンがダウンしていることを確認してください。

Expand

表6.582 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リセットを非同期で実行する必要があるかどうかを示します。
`disks`	Disk[]	In	スナップショットの復元に含まれるディスクを指定します。
`restore_memory`	ブール値	In

6.190.3.1. disks
リンクのコピー

スナップショットの復元に含まれるディスクを指定します。

ディスクパラメーターごとに、その image_id も指定する必要があります。

たとえば、識別子が 111 で image_id が 222 のディスクを含む、識別子が 123 の仮想マシンの識別子が 456 のスナップショットを復元するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/snapshots/456/restore

POST /ovirt-engine/api/vms/123/snapshots/456/restore

Copy to Clipboard

Toggle word wrap

リクエスト本文:

<action>
  <disks>
    <disk id="111">
      <image_id>222</image_id>
    </disk>
  </disks>
</action>

<action>
  <disks>
    <disk id="111">
      <image_id>222</image_id>
    </disk>
  </disks>
</action>

Copy to Clipboard

Toggle word wrap

6.191. SnapshotCdrom
リンクのコピー

Expand

表6.583 メソッドの概要
名前	Summary
`get`

6.191.1. get GET
リンクのコピー

Expand

表6.584 パラメーターの概要
名前	型	方向	Summary
`cdrom`	Cdrom	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.191.1.1. follow
リンクのコピー

6.192. SnapshotCdroms
リンクのコピー

仮想マシンのスナップショットの CD-ROM デバイスのセットを管理します。

Expand

表6.585 メソッドの概要
名前	Summary
`list`	スナップショットの CD-ROM デバイスのリストを返します。

6.192.1. list GET
リンクのコピー

スナップショットの CD-ROM デバイスのリストを返します。

返される CD-ROM デバイスリストの順序は保証されません。

Expand

表6.586 パラメーターの概要
名前	型	方向	Summary
`cdroms`	Cdrom[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す CDROM の最大数を設定します。

6.192.1.1. follow
リンクのコピー

6.192.1.2. max
リンクのコピー

返す CDROM の最大数を設定します。指定されていない場合は、すべての CDROM が返されます。

6.193. SnapshotDisk
リンクのコピー

Expand

表6.587 メソッドの概要
名前	Summary
`get`

6.193.1. get GET
リンクのコピー

Expand

表6.588 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.193.1.1. follow
リンクのコピー

6.194. SnapshotDisks
リンクのコピー

スナップショットのディスクセットを管理します。

Expand

表6.589 メソッドの概要
名前	Summary
`list`	スナップショットのディスクのリストを返します。

6.194.1. list GET
リンクのコピー

スナップショットのディスクのリストを返します。

返されるフックリストの順序は保証されません。

Expand

表6.590 パラメーターの概要
名前	型	方向	Summary
`disks`	Disk[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。

6.194.1.1. follow
リンクのコピー

6.194.1.2. max
リンクのコピー

返すディスクの最大数を設定します。指定しない場合、すべてのディスクが返されます。

6.195. SnapshotNic
リンクのコピー

Expand

表6.591 メソッドの概要
名前	Summary
`get`

6.195.1. get GET
リンクのコピー

Expand

表6.592 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`nic`	Nic	Out

6.195.1.1. follow
リンクのコピー

6.196. SnapshotNics
リンクのコピー

スナップショットの NIC のセットを管理します。

Expand

表6.593 メソッドの概要
名前	Summary
`list`	スナップショットの NIC のリストを返します。

6.196.1. list GET
リンクのコピー

スナップショットの NIC のリストを返します。

返される NIC リストの順序は保証されません。

Expand

表6.594 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す NIC の最大数を設定します。
`nics`	Nic[]	Out

6.196.1.1. follow
リンクのコピー

6.196.1.2. max
リンクのコピー

返す NIC の最大数を設定します。指定されていない場合は、すべての NIC が返されます。

6.197. Snapshots
リンクのコピー

ストレージドメインまたは仮想マシンの一連のスナップショットを管理します。

Expand

表6.595 メソッドの概要
名前	Summary
`add`	仮想マシンのスナップショットを作成します。
`list`	ストレージドメインまたは仮想マシンのスナップショットのリストを返します。

6.197.1. add POST
リンクのコピー

仮想マシンのスナップショットを作成します。

たとえば、仮想マシン 123 の新しいスナップショットを作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/snapshots

POST /ovirt-engine/api/vms/123/snapshots

Copy to Clipboard

Toggle word wrap

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

<snapshot>
  <description>My snapshot</description>
</snapshot>

<snapshot>
  <description>My snapshot</description>
</snapshot>

Copy to Clipboard

Toggle word wrap

スナップショットにディスクのサブセットのみを含めるには、リクエスト本文に disk_attachments 要素を追加します。disk_attachments 要素で指定されていないディスクは、スナップショットの一部にならないことに注意してください。空の disk_attachments 要素が渡された場合は、スナップショットには仮想マシン設定のみが含まれます。disk_attachments 要素が渡されない場合は、すべてのディスクがスナップショットに含まれます。

ディスクごとに、新しいアクティブなイメージ ID を設定するために image_id 要素を指定することができます。これは、バックアップから一連のイメージを復元するために使用されます。つまり、スナップショットを使用してディスクを復元する場合、関連する image_id を各スナップショットに指定する必要があります (ディスクスナップショットの識別子がバックアップと同一になるようにするため)。

<snapshot>
  <description>My snapshot</description>
  <disk_attachments>
    <disk_attachment>
      <disk id="123">
        <image_id>456</image_id>
      </disk>
    </disk_attachment>
  </disk_attachments>
</snapshot>

<snapshot>
  <description>My snapshot</description>
  <disk_attachments>
    <disk_attachment>
      <disk id="123">
        <image_id>456</image_id>
      </disk>
    </disk_attachment>
  </disk_attachments>
</snapshot>

Copy to Clipboard

Toggle word wrap

重要

スナップショットが作成されるとき、persist_memorystate 属性のデフォルト値は true になります。これは、仮想マシンのメモリーの内容がスナップショットに含まれることを意味し、仮想マシンが長時間一時停止されることも意味します。これは、時間的な制約が厳しいアプリケーション (NTP サーバーなど) に悪影響を与える可能性があります。そのような場合は、属性を false に設定してください。

<snapshot>
  <description>My snapshot</description>
  <persist_memorystate>false</persist_memorystate>
</snapshot>

<snapshot>
  <description>My snapshot</description>
  <persist_memorystate>false</persist_memorystate>
</snapshot>

Copy to Clipboard

Toggle word wrap

Expand

表6.596 パラメーターの概要
名前	型	方向	Summary
`snapshot`	スナップショット	In/Out

6.197.2. list GET
リンクのコピー

ストレージドメインまたは仮想マシンのスナップショットのリストを返します。

返されるスナップショットリストの順序は保証されません。

Expand

表6.597 パラメーターの概要
名前	型	方向	Summary
`all_content`	ブール値	In	仮想マシンのスナップショットのすべての属性を応答に含める必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すスナップショットの最大数を設定します。
`snapshots`	Snapshot[]	Out

6.197.2.1. all_content
リンクのコピー

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

デフォルトでは、属性 initialization.configuration.data は除外されています。

たとえば、ID 123 スナップショットを持つ仮想マシンの完全な表現を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/vms/123/snapshots?all_content=true

GET /ovirt-engine/api/vms/123/snapshots?all_content=true

Copy to Clipboard

Toggle word wrap

6.197.2.2. follow
リンクのコピー

6.197.2.3. max
リンクのコピー

返すスナップショットの最大数を設定します。指定されていない場合は、すべてのスナップショットが返されます。

6.198. SshPublicKey
リンクのコピー

Expand

表6.598 メソッドの概要
名前	Summary
`get`
`remove`
`update`	キーを新しいリソースに置き換えます。

6.198.1. get GET
リンクのコピー

Expand

表6.599 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`key`	SshPublicKey	Out

6.198.1.1. follow
リンクのコピー

6.198.2. remove DELETE
リンクのコピー

Expand

表6.600 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.198.3. update PUT
リンクのコピー

キーを新しいリソースに置き換えます。

重要

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

Expand

表6.601 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`key`	SshPublicKey	In/Out

6.199. SshPublicKeys
リンクのコピー

Expand

表6.602 メソッドの概要
名前	Summary
`add`
`list`	ユーザーの SSH 公開鍵のリストを返します。

6.199.1. add POST
リンクのコピー

Expand

表6.603 パラメーターの概要
名前	型	方向	Summary
`key`	SshPublicKey	In/Out

6.199.2. list GET
リンクのコピー

ユーザーの SSH 公開鍵のリストを返します。

たとえば、識別子 123 を持つユーザーの SSH キーのリストを取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/users/123/sshpublickeys

GET /ovirt-engine/api/users/123/sshpublickeys

Copy to Clipboard

Toggle word wrap

結果は以下の XML ドキュメントになります。

<ssh_public_keys>
  <ssh_public_key href="/ovirt-engine/api/users/123/sshpublickeys/456" id="456">
    <content>ssh-rsa ...</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </ssh_public_key>
</ssh_public_keys>

<ssh_public_keys>
  <ssh_public_key href="/ovirt-engine/api/users/123/sshpublickeys/456" id="456">
    <content>ssh-rsa ...</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </ssh_public_key>
</ssh_public_keys>

Copy to Clipboard

Toggle word wrap

または、以下の JSON オブジェクトになります。

{
  "ssh_public_key": [
    {
      "content": "ssh-rsa ...",
      "user": {
        "href": "/ovirt-engine/api/users/123",
        "id": "123"
      },
      "href": "/ovirt-engine/api/users/123/sshpublickeys/456",
      "id": "456"
    }
  ]
}

{
  "ssh_public_key": [
    {
      "content": "ssh-rsa ...",
      "user": {
        "href": "/ovirt-engine/api/users/123",
        "id": "123"
      },
      "href": "/ovirt-engine/api/users/123/sshpublickeys/456",
      "id": "456"
    }
  ]
}

Copy to Clipboard

Toggle word wrap

返されるキーリストの順序は保証されません。

Expand

表6.604 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`keys`	SshPublicKey[]	Out
`max`	Integer	In	返すことのできるキーの最大数。

6.199.2.1. follow
リンクのコピー

6.199.2.2. max
リンクのコピー

返すことのできるキーの最大数。指定されていない場合は、すべてのキーが返されます。

6.200. 統計
リンクのコピー

Expand

表6.605 メソッドの概要
名前	Summary
`get`

6.200.1. get GET
リンクのコピー

Expand

表6.606 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`statistic`	統計	Out

6.200.1.1. follow
リンクのコピー

6.201. 統計
リンクのコピー

Expand

表6.607 メソッドの概要
名前	Summary
`list`	統計のリストを取得します。

6.201.1. list GET
リンクのコピー

統計のリストを取得します。

たとえば、仮想マシン 123 の統計を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/vms/123/statistics

GET /ovirt-engine/api/vms/123/statistics

Copy to Clipboard

Toggle word wrap

結果は以下のようになります。

<statistics>
  <statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
    <name>memory.installed</name>
    <description>Total memory configured</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>1073741824</datum>
      </value>
    </values>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </statistic>
  ...
</statistics>

<statistics>
  <statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
    <name>memory.installed</name>
    <description>Total memory configured</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>1073741824</datum>
      </value>
    </values>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </statistic>
  ...
</statistics>

Copy to Clipboard

Toggle word wrap

URI の末尾に ID を指定することで、統計の一部のみを取得できます。つまり、以下のようになります。

GET /ovirt-engine/api/vms/123/statistics/456

GET /ovirt-engine/api/vms/123/statistics/456

Copy to Clipboard

Toggle word wrap

出力:

<statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
  <name>memory.installed</name>
  <description>Total memory configured</description>
  <kind>gauge</kind>
  <type>integer</type>
  <unit>bytes</unit>
  <values>
    <value>
      <datum>1073741824</datum>
    </value>
  </values>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</statistic>

<statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
  <name>memory.installed</name>
  <description>Total memory configured</description>
  <kind>gauge</kind>
  <type>integer</type>
  <unit>bytes</unit>
  <values>
    <value>
      <datum>1073741824</datum>
    </value>
  </values>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</statistic>

Copy to Clipboard

Toggle word wrap

返される統計リストの順序は保証されません。

Expand

表6.608 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す統計の最大数を設定します。
`statistics`	Statistic[]	Out

6.201.1.1. follow
リンクのコピー

6.201.1.2. max
リンクのコピー

返す統計の最大数を設定します。指定されていない場合は、すべての統計が返されます。

6.202. Step
リンクのコピー

ステップを管理するサービス。

Expand

表6.609 メソッドの概要
名前	Summary
`end`	外部ステップの実行を終了としてマークします。
`get`	ステップを取得します。

6.202.1. end POST
リンクのコピー

外部ステップの実行を終了としてマークします。

たとえば、識別子 123 の job に属する識別子 456 のステップを終了するには、以下のリクエストを送信します。

POST /ovirt-engine/api/jobs/123/steps/456/end

POST /ovirt-engine/api/jobs/123/steps/456/end

Copy to Clipboard

Toggle word wrap

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

<action>
  <force>true</force>
  <succeeded>true</succeeded>
</action>

<action>
  <force>true</force>
  <succeeded>true</succeeded>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.610 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In	ステップを強制終了する必要があるかどうかを示します。
`succeeded`	ブール値	In	ステップを正常終了または失敗としてマークする必要があるかどうかを示します。

6.202.1.1. succeeded
リンクのコピー

ステップを正常終了または失敗としてマークする必要があるかどうかを示します。

このパラメーターはオプションであり、デフォルト値は true です。

6.202.2. get GET
リンクのコピー

ステップを取得します。

GET /ovirt-engine/api/jobs/123/steps/456

GET /ovirt-engine/api/jobs/123/steps/456

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <end_time>2016-12-12T23:07:26.627+02:00</end_time>
  <external>false</external>
  <number>0</number>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>finished</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <end_time>2016-12-12T23:07:26.627+02:00</end_time>
  <external>false</external>
  <number>0</number>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>finished</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>

Copy to Clipboard

Toggle word wrap

Expand

表6.611 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`step`	Step	Out	ステップの表現を取得します。

6.202.2.1. follow
リンクのコピー

6.203. Steps
リンクのコピー

ステップを管理するサービスです。

Expand

表6.612 メソッドの概要
名前	Summary
`add`	外部ステップを既存のジョブまたは既存のステップに追加します。
`list`	ステップの表現を取得します。

6.203.1. add POST
リンクのコピー

外部ステップを既存のジョブまたは既存のステップに追加します。

たとえば、識別子が 123 の job にステップを追加するには、以下のリクエストを送信します。

POST /ovirt-engine/api/jobs/123/steps

POST /ovirt-engine/api/jobs/123/steps

Copy to Clipboard

Toggle word wrap

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

<step>
  <description>Validating</description>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>started</status>
  <type>validating</type>
</step>

<step>
  <description>Validating</description>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>started</status>
  <type>validating</type>
</step>

Copy to Clipboard

Toggle word wrap

応答は以下のようになります。

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
  <external>true</external>
  <number>2</number>
  <start_time>2016-12-13T01:06:15.380+02:00</start_time>
  <status>started</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
  <external>true</external>
  <number>2</number>
  <start_time>2016-12-13T01:06:15.380+02:00</start_time>
  <status>started</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>

Copy to Clipboard

Toggle word wrap

Expand

表6.613 パラメーターの概要
名前	型	方向	Summary
`step`	Step	In/Out	追加されるステップ。

6.203.2. list GET
リンクのコピー

ステップの表現を取得します。

GET /ovirt-engine/api/job/123/steps

GET /ovirt-engine/api/job/123/steps

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<steps>
  <step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
    <actions>
      <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
    </actions>
    <description>Validating</description>
    <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
    <external>true</external>
    <number>2</number>
    <start_time>2016-12-13T01:06:15.380+02:00</start_time>
    <status>started</status>
    <type>validating</type>
    <job href="/ovirt-engine/api/jobs/123" id="123"/>
  </step>
  ...
</steps>

<steps>
  <step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
    <actions>
      <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
    </actions>
    <description>Validating</description>
    <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
    <external>true</external>
    <number>2</number>
    <start_time>2016-12-13T01:06:15.380+02:00</start_time>
    <status>started</status>
    <type>validating</type>
    <job href="/ovirt-engine/api/jobs/123" id="123"/>
  </step>
  ...
</steps>

Copy to Clipboard

Toggle word wrap

返されるステップリストの順序は保証されません。

Expand

表6.614 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すステップの最大数を設定します。
`steps`	Step[]	Out	ステップの表現。

6.203.2.1. follow
リンクのコピー

6.203.2.2. max
リンクのコピー

返すステップの最大数を設定します。指定されていない場合は、すべてのステップが返されます。

6.204. ストレージ
リンクのコピー

Expand

表6.615 メソッドの概要
名前	Summary
`get`

6.204.1. get GET
リンクのコピー

Expand

表6.616 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`report_status`	ブール値	In	ストレージ内の LUN のステータスを確認する必要があるかどうかを示します。
`storage`	HostStorage	Out

6.204.1.1. follow
リンクのコピー

6.204.1.2. report_status
リンクのコピー

デフォルトは、後方互換性を確保するために true です。

LUN ステータスの例を次に示します。

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>

Copy to Clipboard

Toggle word wrap

これは、LUN ステータスのない例です。

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>

Copy to Clipboard

Toggle word wrap

6.205. StorageDomain
リンクのコピー

Expand

表6.617 メソッドの概要
名前	Summary
`get`	ストレージドメインの説明を取得します。
`isattached`	ストレージサーバーの一部である is_attached ブール値フィールドを使用して、ストレージドメインがすでにデータセンターにアタッチされているかどうかをクエリーするために使用されます。
`reduceluns`	この操作により、ストレージドメインから論理ユニットが削減されます。
`refreshluns`	この操作により、LUN サイズが更新されます。
`remove`	ストレージドメインを削除します。
`update`	ストレージドメインを更新します。
`updateovfstore`	この操作により、このストレージドメインの `OVF_STORE` が強制的に更新されます。

6.205.1. get GET
リンクのコピー

ストレージドメインの説明を取得します。

Expand

表6.618 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`storage_domain`	StorageDomain	Out	ストレージドメインの説明。

6.205.1.1. follow
リンクのコピー

6.205.2. isattached POST
リンクのコピー

ストレージサーバーの一部である is_attached ブール値フィールドを使用して、ストレージドメインがすでにデータセンターにアタッチされているかどうかをクエリーするために使用されます。重要: この API を実行すると、ホストがストレージドメインから切断されます。

Expand

表6.619 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。
`host`	ホスト	In	データセンターのホストを示します。
`is_attached`	ブール値	Out	ストレージドメインがデータセンターにアタッチされているかどうかを示します。

6.205.3. reduceluns POST
リンクのコピー

この操作により、ストレージドメインから論理ユニットが削減されます。

そのために、提供された論理ユニットに保存されているデータは、ストレージドメインの他の論理ユニットに移動され、その後、ストレージドメインから削減されます。

たとえば、ストレージドメインから 2 つの論理ユニットを削減するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/storageDomains/123/reduceluns

POST /ovirt-engine/api/storageDomains/123/reduceluns

Copy to Clipboard

Toggle word wrap

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

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>

Copy to Clipboard

Toggle word wrap

Note that this operation is only applicable to block storage domains (i.e., storage domains with the
xref:types-storage_type[storage type] of iSCSI or FCP).

Note that this operation is only applicable to block storage domains (i.e., storage domains with the
xref:types-storage_type[storage type] of iSCSI or FCP).

Copy to Clipboard

Toggle word wrap

Expand

表6.620 パラメーターの概要
名前	型	方向	Summary
`logical_units`	LogicalUnit[]	In	ストレージドメインから削減する必要がある論理ユニット。

6.205.4. refreshluns POST
リンクのコピー

この操作により、LUN サイズが更新されます。

ストレージサーバーの基盤となる LUN のサイズを増やした後、ユーザーは LUN サイズを更新できます。このアクションは、提供された LUN の再スキャンを強制し、必要に応じて新しいサイズでデータベースを更新します。

たとえば、2 つの LUN のサイズを更新するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/storageDomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns

POST /ovirt-engine/api/storageDomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns

Copy to Clipboard

Toggle word wrap

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

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>

Copy to Clipboard

Toggle word wrap

Expand

表6.621 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リフレッシュを非同期で実行する必要があるかどうかを示します。
`logical_units`	LogicalUnit[]	In	更新が必要な LUN。

6.205.5. remove DELETE
リンクのコピー

ストレージドメインを削除します。

特別なパラメーターがない場合、ストレージドメインはシステムから切り離され、データベースから削除されます。その後、ストレージドメインは、同じセットアップまたは別のセットアップに、すべてのデータとともにインポートできます。ストレージにアクセスできない場合、操作は失敗します。

destroy パラメーターが true の場合、ストレージにアクセスできない場合でも、操作は常に成功し、失敗は無視され、いずれにせよストレージドメインはデータベースから削除されます。

format パラメーターが true の場合、実際のストレージがフォーマットされ、LUN またはディレクトリーからメタデータが削除されるため、同じセットアップまたは異なるセットアップにインポートできません。

Expand

表6.622 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。
`destroy`	ブール値	In	ストレージにアクセスできない場合でも、操作が成功してストレージドメインがデータベースから削除されるかどうかを示します。
`format`	ブール値	In	実際のストレージをフォーマットし、基盤となる LUN またはディレクトリーからすべてのメタデータを削除するかどうかを示します。 [source] ---- DELETE /ovirt-engine/api/storageDomains/123?format=true ---- このパラメーターはオプションであり、デフォルト値は `false` です。
`host`	String	In	ストレージドメインの削除に使用するホストを示します。

6.205.5.1. destroy
リンクのコピー

ストレージにアクセスできない場合でも、操作が成功してストレージドメインがデータベースから削除されるかどうかを示します。

DELETE /ovirt-engine/api/storageDomains/123?destroy=true

DELETE /ovirt-engine/api/storageDomains/123?destroy=true

Copy to Clipboard

Toggle word wrap

このパラメーターはオプションであり、デフォルト値は false です。destroy の値が true の場合、host パラメーターは無視されます。

6.205.5.2. host
リンクのコピー

ストレージドメインの削除に使用するホストを示します。

このパラメーターは必須です。ただし、destroy パラメーターが含まれていて、その値が true である場合を除きます。この場合、host パラメーターは無視されます。

値には、ホストの名前または識別子が含まれている必要があります。たとえば、myhost という名前のホストを使用して、識別子 123 のストレージドメインを削除するには、以下のようなリクエストを送信します。

DELETE /ovirt-engine/api/storageDomains/123?host=myhost

DELETE /ovirt-engine/api/storageDomains/123?host=myhost

Copy to Clipboard

Toggle word wrap

6.205.6. update PUT
リンクのコピー

ストレージドメインを更新します。

StorageDomain の属性のすべてが、作成後に更新可能なわけではありません。更新できるのは、name、description、comment、warning_low_space_indicator、critical_space_action_blocker、および wipe_after_delete です。(wipe_after_delete 属性を変更しても、すでに存在するディスクの wipe after delete プロパティーは変更されないことに注意してください)。

識別子 123 を持つストレージドメインの name 属性と wipe_after_delete 属性を更新するには、以下のようにリクエストを送信する。

PUT /ovirt-engine/api/storageDomains/123

PUT /ovirt-engine/api/storageDomains/123

Copy to Clipboard

Toggle word wrap

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

<storage_domain>
  <name>data2</name>
  <wipe_after_delete>true</wipe_after_delete>
</storage_domain>

<storage_domain>
  <name>data2</name>
  <wipe_after_delete>true</wipe_after_delete>
</storage_domain>

Copy to Clipboard

Toggle word wrap

Expand

表6.623 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`storage_domain`	StorageDomain	In/Out	更新されたストレージドメイン。

6.205.7. updateovfstore POST
リンクのコピー

この操作により、このストレージドメインの OVF_STORE が強制的に更新されます。

OVF_STORE は、ストレージドメインに存在する仮想マシンとディスクのメタデータを格納したディスクイメージです。このメタデータは、ドメインが別のデータセンターまたは別のインストールとの間でインポートまたはエクスポートされる場合に使用されます。

デフォルトでは、OVF_STORE は定期的に更新されますが (デフォルトでは 60 分に設定)、重要な変更後や OVF_STORE が破損していると思われる場合に、ユーザーは更新を強制する必要があることもあります。

ユーザーによって開始された場合、OVF_STORE 更新は、更新の必要性の有無にかかわらず実行されます。

Expand

表6.624 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	`OVF_STORE` 更新を非同期的に実行するかどうかを示します。

6.206. StorageDomainContentDisk
リンクのコピー

Expand

表6.625 メソッドの概要
名前	Summary
`get`

6.206.1. get GET
リンクのコピー

Expand

表6.626 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	Out
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.206.1.1. follow
リンクのコピー

6.207. StorageDomainContentDisks
リンクのコピー

ストレージドメインで利用可能なディスクのセットを管理します。

Expand

表6.627 メソッドの概要
名前	Summary
`list`	ストレージドメインで利用可能なディスクのリストを返します。

6.207.1. list GET
リンクのコピー

ストレージドメインで利用可能なディスクのリストを返します。

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

Expand

表6.628 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`disks`	Disk[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。
`search`	String	In	返されたディスクを制限するために使用されるクエリー文字列。

6.207.1.1. case_sensitive
リンクのコピー

6.207.1.2. follow
リンクのコピー

6.207.1.3. max
リンクのコピー

返すディスクの最大数を設定します。指定しない場合、すべてのディスクが返されます。

6.208. StorageDomainDisk
リンクのコピー

ストレージドメインで利用可能な単一のディスクを管理します。

重要

Expand

表6.629 メソッドの概要
名前	Summary
`copy`	指定したストレージドメインにディスクをコピーします。
`export`	ディスクをエクスポートストレージドメインにエクスポートします。
`get`	ディスクの説明を取得します。
`move`	ディスクを別のストレージドメインに移動します。
`reduce`	ディスクイメージのサイズを縮小します。
`remove`	ディスクを削除します。
`sparsify`	ディスクをスパース化します。
`update`	ディスクを更新します。

6.208.1. copy POST
リンクのコピー

指定したストレージドメインにディスクをコピーします。

重要

Expand

表6.630 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In	作成されるディスクの説明。
`storage_domain`	StorageDomain	In	新しいディスクが作成されるストレージドメイン。

6.208.2. export POST
リンクのコピー

ディスクをエクスポートストレージドメインにエクスポートします。

重要

Expand

表6.631 パラメーターの概要
名前	型	方向	Summary
`storage_domain`	StorageDomain	In	ディスクがエクスポートされるエクスポートストレージドメイン。

6.208.3. get GET
リンクのコピー

ディスクの説明を取得します。

Expand

表6.632 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	Out	ディスクの説明。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.208.3.1. follow
リンクのコピー

6.208.4. move POST
リンクのコピー

ディスクを別のストレージドメインに移動します。

重要

Expand

表6.633 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	移動を非同期で実行する必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`storage_domain`	StorageDomain	In	ディスクが移動されるストレージドメイン。

6.208.5. reduce POST
リンクのコピー

ディスクイメージのサイズを縮小します。

Expand

表6.634 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.208.6. remove DELETE
リンクのコピー

ディスクを削除します。

重要

6.208.7. sparsify POST
リンクのコピー

ディスクをスパース化します。

重要

6.208.8. update PUT
リンクのコピー

ディスクを更新します。

重要

Expand

表6.635 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In/Out	ディスクに適用する更新。

6.209. StorageDomainDisks
リンクのコピー

特定のストレージドメイン内で利用可能なディスクコレクションを管理します。

Expand

表6.636 メソッドの概要
名前	Summary
`add`	ディスクを追加または登録します。
`list`	ストレージドメインで利用可能なディスクのリストを取得する。

6.209.1. add POST
リンクのコピー

ディスクを追加または登録します。

重要

Red Hat Virtualization Manager のバージョン 4.2 以降、この操作は非推奨となり、後方互換性のためにのみ保持されています。これは今後削除されます。新しいディスクを追加するには、システムのディスクを管理するサービスの add 操作を使用します。未登録のディスクを登録するには、そのディスクを管理するサービスの登録操作を使用します。

Expand

表6.637 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In/Out	追加または登録するディスク。
`unregistered`	ブール値	In	新しいディスクを追加するか、または既存の登録されていないディスクを登録する必要があるかどうかを示します。

6.209.1.1. unregistered
リンクのコピー

新しいディスクを追加するか、または既存の登録されていないディスクを登録する必要があるかどうかを示します。値が true の場合、登録するディスクの ID を指定する必要があります。たとえば、ID 456 のディスクを登録する場合は、以下のようなリクエストを送信します。

POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true

POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true

Copy to Clipboard

Toggle word wrap

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

<disk id="456"/>

<disk id="456"/>

Copy to Clipboard

Toggle word wrap

POST /ovirt-engine/api/storagedomains/123/disks

POST /ovirt-engine/api/storagedomains/123/disks

Copy to Clipboard

Toggle word wrap

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

<disk>
  <name>mydisk</name>
  <format>cow</format>
  <provisioned_size>1073741824</provisioned_size>
</disk>

<disk>
  <name>mydisk</name>
  <format>cow</format>
  <provisioned_size>1073741824</provisioned_size>
</disk>

Copy to Clipboard

Toggle word wrap

デフォルト値は false です。

このパラメーターは、Red Hat Virtualization Manager のバージョン 4.2 以降で非推奨となっています。

6.209.2. list GET
リンクのコピー

ストレージドメインで利用可能なディスクのリストを取得する。

返されるディスクリストの順序は保証されません。

Expand

表6.638 パラメーターの概要
名前	型	方向	Summary
`disks`	Disk[]	Out	取得されたディスクのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。
`unregistered`	ブール値	In	ストレージドメイン内の登録済みディスクまたは未登録ディスクのリストを取得するかどうかを示します。

6.209.2.1. follow
リンクのコピー

6.209.2.2. max
リンクのコピー

返すディスクの最大数を設定します。指定されていない場合は、すべてのディスクが返されます。

6.209.2.3. unregistered
リンクのコピー

ストレージドメイン内の登録済みディスクまたは未登録ディスクのリストを取得するかどうかを示します。ストレージドメイン内の未登録ディスクのリストを取得するには、呼び出しで未登録フラグを示す必要があります。たとえば、未登録ディスクのリストを取得するための REST API 呼び出しは、以下のようになります。

GET /ovirt-engine/api/storagedomains/123/disks?unregistered=true

GET /ovirt-engine/api/storagedomains/123/disks?unregistered=true

Copy to Clipboard

Toggle word wrap

未登録フラグのデフォルト値は false です。リクエストは、アタッチされているストレージドメインにのみ適用されます。

6.210. StorageDomainServerConnection
リンクのコピー

Expand

表6.639 メソッドの概要
名前	Summary
`get`
`remove`	ストレージ接続をストレージから切り離します。

6.210.1. get GET
リンクのコピー

Expand

表6.640 パラメーターの概要
名前	型	方向	Summary
`connection`	StorageConnection	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.210.1.1. follow
リンクのコピー

6.210.2. remove DELETE
リンクのコピー

ストレージ接続をストレージから切り離します。

Expand

表6.641 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.211. StorageDomainServerConnections
リンクのコピー

ストレージドメインに存在するストレージサーバーへの一連の接続を管理します。

Expand

表6.642 メソッドの概要
名前	Summary
`add`
`list`	ストレージドメインに存在するストレージサーバーへの接続のリストを返します。

6.211.1. add POST
リンクのコピー

Expand

表6.643 パラメーターの概要
名前	型	方向	Summary
`connection`	StorageConnection	In/Out

6.211.2. list GET
リンクのコピー

ストレージドメインに存在するストレージサーバーへの接続のリストを返します。

返される接続リストの順序は保証されません。

Expand

表6.644 パラメーターの概要
名前	型	方向	Summary
`connections`	StorageConnection[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す接続の最大数を設定します。

6.211.2.1. follow
リンクのコピー

6.211.2.2. max
リンクのコピー

返す接続の最大数を設定します。指定しない場合、すべての接続が返されます。

6.212. StorageDomainTemplate
リンクのコピー

Expand

表6.645 メソッドの概要
名前	Summary
`get`
`import`	エクスポートストレージドメインからテンプレートをインポートするアクション。
`register`	テンプレートの登録とは、テンプレートとディスクの設定をコピープロセスなしでデータベースに挿入することにより、データドメインからテンプレートをインポートすることを意味します。
`remove`

6.212.1. get GET
リンクのコピー

Expand

表6.646 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`テンプレート`	テンプレート	Out

6.212.1.1. follow
リンクのコピー

6.212.2. import POST
リンクのコピー

エクスポートストレージドメインからテンプレートをインポートするアクション。

たとえば、ストレージドメイン 123 からテンプレート 456 をインポートするには、次のリクエストを送信します。

POST /ovirt-engine/api/storagedomains/123/templates/456/import

POST /ovirt-engine/api/storagedomains/123/templates/456/import

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>

Copy to Clipboard

Toggle word wrap

クラスター ID または名前を指定せずにエンティティーを登録すると、エンティティーの OVF からのクラスター名が使用されます (登録要求にクラスターマッピングも含まれていない場合)。

Expand

表6.647 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	インポートを非同期で実行する必要があるかどうかを示します。
`clone`	ブール値	In	オプションの `clone` パラメーターを使用して、インポートされたテンプレートとそのエンティティーの新しい UUID を生成します。
`cluster`	クラスター	In
`exclusive`	ブール値	In
`storage_domain`	StorageDomain	In
`template`	テンプレート	In
`vm`	Vm	In

6.212.2.1. clone
リンクのコピー

オプションの clone パラメーターを使用して、インポートされたテンプレートとそのエンティティーの新しい UUID を生成します。

別の Red Hat Virtualization 環境によってエクスポートされたテンプレートを使用して、エクスポートドメインからテンプレートをインポートするときに、clone パラメーターを false に設定してテンプレートをインポートできます。

6.212.3. register POST
リンクのコピー

テンプレートの登録とは、テンプレートとディスクの設定をコピープロセスなしでデータベースに挿入することにより、データドメインからテンプレートをインポートすることを意味します。

Expand

表6.648 パラメーターの概要
名前	型	方向	Summary
`allow_partial_import`	ブール値	In	一部のディスクのみにテンプレートを登録できるかどうかを示します。
`async`	ブール値	In	登録を非同期的に実行するかどうかを指定します。
`clone`	ブール値	In
`cluster`	クラスター	In
`exclusive`	ブール値	In
`registration_configuration`	RegistrationConfiguration	In	このパラメーターは、テンプレートの登録方法を記述します。
`template`	テンプレート	In
`vnic_profile_mappings`	VnicProfileMapping[]	In	インポート/登録プロセス中に適用される仮想 NIC プロファイルのマッピングルールを記述する非推奨となった属性。

6.212.3.1. allow_partial_import
リンクのコピー

一部のディスクのみにテンプレートを登録できるかどうかを示します。

このフラグが true の場合、イメージが見つからなくても、システムは検証プロセスで失敗しませんが、代わりに、不足しているディスクなしでテンプレートを登録できます。これは主に、一部のストレージドメインが使用できない場合のテンプレートの登録中に使用されます。デフォルト値は false です。

6.212.3.2. registration_configuration
リンクのコピー

このパラメーターは、テンプレートの登録方法を記述します。

このパラメーターは任意です。パラメーターが指定されていない場合、テンプレートは作成された元の環境と同じ設定で登録されます。

6.212.3.3. vnic_profile_mappings
リンクのコピー

インポート/登録プロセス中に適用される仮想 NIC プロファイルのマッピングルールを記述する非推奨となった属性。

警告

この属性は、エンジンのバージョン 4.2.1 以降は非推奨となっており、後方互換性のためにのみ保持されていることに注意してください。これは今後削除されます。vnic_profile_mappings を指定するには、RegistrationConfiguration タイプ内の vnic_profile_mappings 属性を使用します。

6.212.4. remove DELETE
リンクのコピー

Expand

表6.649 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.213. StorageDomainTemplates
リンクのコピー

ストレージドメインで利用可能な一連のテンプレートを管理します。

Expand

表6.650 メソッドの概要
名前	Summary
`list`	ストレージドメインで利用可能なテンプレートのリストを返します。

6.213.1. list GET
リンクのコピー

ストレージドメインで利用可能なテンプレートのリストを返します。

返されるテンプレートリストの順序は保証されません。

Expand

表6.651 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すテンプレートの最大数を設定します。
`templates`	Template[]	Out
`unregistered`	ブール値	In	ストレージドメイン上のディスクを含む登録済みまたは未登録のテンプレートのリストを取得するかどうかを示します。

6.213.1.1. follow
リンクのコピー

6.213.1.2. max
リンクのコピー

返すテンプレートの最大数を設定します。指定されていない場合は、すべてのテンプレートが返されます。

6.213.1.3. unregistered
リンクのコピー

ストレージドメイン上のディスクを含む登録済みまたは未登録のテンプレートのリストを取得するかどうかを示します。未登録テンプレートのリストを取得するには、呼び出しで未登録フラグを指定する必要があります。たとえば、未登録テンプレートのリストを取得するための REST API 呼び出しは、以下のようになります。

GET /ovirt-engine/api/storagedomains/123/templates?unregistered=true

GET /ovirt-engine/api/storagedomains/123/templates?unregistered=true

Copy to Clipboard

Toggle word wrap

未登録フラグのデフォルト値は false です。リクエストは、アタッチされているストレージドメインにのみ適用されます。

6.214. StorageDomainVm
リンクのコピー

Expand

表6.652 メソッドの概要
名前	Summary
`get`
`import`	エクスポートストレージドメインから仮想マシンをインポートします。
`register`
`remove`	エクスポートストレージドメインから仮想マシンを削除します。

6.214.1. get GET
リンクのコピー

Expand

表6.653 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`vm`	Vm	Out

6.214.1.1. follow
リンクのコピー

6.214.2. import POST
リンクのコピー

エクスポートストレージドメインから仮想マシンをインポートします。

たとえば、次のようなリクエストを送信します。

POST /ovirt-engine/api/storagedomains/123/vms/456/import

POST /ovirt-engine/api/storagedomains/123/vms/456/import

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>

Copy to Clipboard

Toggle word wrap

仮想マシンを新しいエンティティーとしてインポートするには、clone パラメーターを追加します。

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <clone>true</clone>
  <vm>
    <name>myvm</name>
  </vm>
</action>

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <clone>true</clone>
  <vm>
    <name>myvm</name>
  </vm>
</action>

Copy to Clipboard

Toggle word wrap

インポートするディスクを選択するために、オプションの disks パラメーターを含めます。たとえば、123 と 456 の識別子を持つテンプレートのディスクをインポートするには、以下のリクエスト本文を送信します。

<action>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <vm>
    <name>myvm</name>
  </vm>
  <disks>
    <disk id="123"/>
    <disk id="456"/>
  </disks>
</action>

<action>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <vm>
    <name>myvm</name>
  </vm>
  <disks>
    <disk id="123"/>
    <disk id="456"/>
  </disks>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.654 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	インポートを非同期で実行する必要があるかどうかを示します。
`clone`	ブール値	In	インポートされた仮想マシンの識別子を再生成する必要があるかどうかを示します。
`cluster`	クラスター	In
`collapse_snapshots`	ブール値	In	スナップショットのない仮想マシンになるように、インポートされた仮想マシンのスナップショットを折りたたむ必要があることを示します。
`exclusive`	ブール値	In
`storage_domain`	StorageDomain	In
`vm`	Vm	In

6.214.2.1. clone
リンクのコピー

インポートされた仮想マシンの識別子を再生成する必要があるかどうかを示します。

デフォルトでは、仮想マシンがインポートされると、識別子が保持されます。つまり、識別子は一意である必要があるため、同じ仮想マシンを複数回インポートすることはできません。同じマシンを複数回インポートできるようにするには、このパラメーターを true に設定します。デフォルトは false です。

6.214.2.2. collapse_snapshots
リンクのコピー

スナップショットのない仮想マシンになるように、インポートされた仮想マシンのスナップショットを折りたたむ必要があることを示します。

このパラメーターはオプションであり、明示的に指定されていない場合、デフォルト値は false です。

6.214.3. register POST
リンクのコピー

Expand

表6.655 パラメーターの概要
名前	型	方向	Summary
`allow_partial_import`	ブール値	In	仮想マシンをその一部のディスクのみに登録できるかどうかを示します。
`async`	ブール値	In	登録を非同期的に実行するかどうかを指定します。
`clone`	ブール値	In
`cluster`	クラスター	In
`reassign_bad_macs`	ブール値	In	エンジンによるインポートプロセス中に、問題のある MAC アドレスを再割り当てする必要があるかどうかを示します。
`registration_configuration`	RegistrationConfiguration	In	このパラメーターは、仮想マシンを登録する方法を記述します。
`vm`	Vm	In
`vnic_profile_mappings`	VnicProfileMapping[]	In	インポート/登録プロセス中に適用される仮想 NIC プロファイルのマッピングルールを記述する非推奨となった属性。

6.214.3.1. allow_partial_import
リンクのコピー

仮想マシンをその一部のディスクのみに登録できるかどうかを示します。

このフラグが true の場合、イメージが見つからなくても、エンジンは検証プロセスで失敗しませんが、代わりに、欠落しているディスクなしで仮想マシンを登録できます。これは主に、一部のストレージドメインが使用できない場合の仮想マシンの登録中に使用されます。デフォルト値は false です。

6.214.3.2. reassign_bad_macs
リンクのコピー

エンジンによるインポートプロセス中に、問題のある MAC アドレスを再割り当てする必要があるかどうかを示します。

次のいずれかに該当する場合、MAC アドレスは問題のあるものと見なされます。

ターゲット環境の仮想マシンにすでに割り当てられている MAC アドレスと競合する。
対象 MAC アドレスプールの範囲外である。

6.214.3.3. registration_configuration
リンクのコピー

このパラメーターは、仮想マシンを登録する方法を記述します。

このパラメーターは任意です。パラメーターが指定されていない場合、仮想マシンは、作成された元の環境と同じ設定で登録されます。

6.214.3.4. vnic_profile_mappings
リンクのコピー

インポート/登録プロセス中に適用される仮想 NIC プロファイルのマッピングルールを記述する非推奨となった属性。

警告

6.214.4. remove DELETE
リンクのコピー

エクスポートストレージドメインから仮想マシンを削除します。

たとえば、仮想マシン 456 をストレージドメイン 123 から削除するには、以下のようなリクエストを送信します。

DELETE /ovirt-engine/api/storagedomains/123/vms/456

DELETE /ovirt-engine/api/storagedomains/123/vms/456

Copy to Clipboard

Toggle word wrap

Expand

表6.656 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.215. StorageDomainVmDiskAttachment
リンクのコピー

エクスポートドメイン内の仮想マシンにアタッチされているディスクの詳細を返します。

Expand

表6.657 メソッドの概要
名前	Summary
`get`	すべてのプロパティーとディスクへのリンクを含むアタッチメントの詳細を返します。

6.215.1. get GET
リンクのコピー

すべてのプロパティーとディスクへのリンクを含むアタッチメントの詳細を返します。

Expand

表6.658 パラメーターの概要
名前	型	方向	Summary
`attachment`	DiskAttachment	Out	ディスクアタッチメント。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.215.1.1. follow
リンクのコピー

6.216. StorageDomainVmDiskAttachments
リンクのコピー

エクスポートドメイン内の仮想マシンにアタッチされているディスクの詳細を返します。

Expand

表6.659 メソッドの概要
名前	Summary
`list`	仮想マシンに接続されているディスクをリスト表示します。

6.216.1. list GET
リンクのコピー

仮想マシンに接続されているディスクをリスト表示します。

返されるディスクアタッチメントリストの順序は保証されません。

Expand

表6.660 パラメーターの概要
名前	型	方向	Summary
`attachments`	DiskAttachment[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.216.1.1. follow
リンクのコピー

6.217. StorageDomainVms
リンクのコピー

エクスポートストレージドメインの仮想マシンをリスト表示します。

たとえば、識別子が 123 のストレージドメインで利用可能な仮想マシンを取得するには、以下のリクエストを送信します。

GET /ovirt-engine/api/storagedomains/123/vms

GET /ovirt-engine/api/storagedomains/123/vms

Copy to Clipboard

Toggle word wrap

これにより、以下のレスポンス本文が返されます。

<vms>
  <vm id="456" href="/api/storagedomains/123/vms/456">
    <name>vm1</name>
    ...
    <storage_domain id="123" href="/api/storagedomains/123"/>
    <actions>
      <link rel="import" href="/api/storagedomains/123/vms/456/import"/>
    </actions>
  </vm>
</vms>

<vms>
  <vm id="456" href="/api/storagedomains/123/vms/456">
    <name>vm1</name>
    ...
    <storage_domain id="123" href="/api/storagedomains/123"/>
    <actions>
      <link rel="import" href="/api/storagedomains/123/vms/456/import"/>
    </actions>
  </vm>
</vms>

Copy to Clipboard

Toggle word wrap

これらのコレクションの仮想マシンとテンプレートは、StorageDomain 参照とインポートアクションも含まれていることを除き、最上位の Vm コレクションと Template コレクションの対応するものと同様の表現をしています。

Expand

表6.661 メソッドの概要
名前	Summary
`list`	エクスポートストレージドメインの仮想マシンのリストを返します。

6.217.1. list GET
リンクのコピー

エクスポートストレージドメインの仮想マシンのリストを返します。

返される仮想マシンリストの順序は保証されません。

Expand

表6.662 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す仮想マシンの最大数を設定します。
`unregistered`	ブール値	In	ストレージドメイン上のディスクを含む登録済みまたは未登録の仮想マシンのリストを取得するかどうかを示します。
`vm`	Vm[]	Out

6.217.1.1. follow
リンクのコピー

6.217.1.2. max
リンクのコピー

返す仮想マシンの最大数を設定します。指定されていない場合は、すべての仮想マシンが返されます。

6.217.1.3. unregistered
リンクのコピー

ストレージドメイン上のディスクを含む登録済みまたは未登録の仮想マシンのリストを取得するかどうかを示します。未登録の仮想マシンのリストを取得するには、呼び出しで未登録フラグを示す必要があります。たとえば、未登録の仮想マシンのリストを取得するには、REST API 呼び出しは次のようになります。

GET /ovirt-engine/api/storagedomains/123/vms?unregistered=true

GET /ovirt-engine/api/storagedomains/123/vms?unregistered=true

Copy to Clipboard

Toggle word wrap

未登録フラグのデフォルト値は false です。リクエストは、アタッチされているストレージドメインにのみ適用されます。

6.218. StorageDomains
リンクのコピー

システム内の一連のストレージドメインを管理します。

Expand

表6.663 メソッドの概要
名前	Summary
`add`	新しいストレージドメインを追加します。
`list`	システム内のストレージドメインのリストを返します。

6.218.1. add POST
リンクのコピー

新しいストレージドメインを追加します。

新しい StorageDomain の作成には、name、type、host、および storage の属性が必要です。id または name 属性で host 属性を特定します。Red Hat Virtualization 3.6 以降では、ストレージドメインでデフォルトによる削除後にワイプオプションを有効にできます。これを設定するには、POST 要求で wipe_after_delete を指定します。このオプションは、ドメインの作成後に編集できますが、その場合はすでに存在している wipe after delete プロパティーは変更されません。

name、type、storage.type、storage.address、storage.path を指定し、ID が 123 のホストを使用して新規ストレージドメインを追加するには、次のような要求を送信します。

POST /ovirt-engine/api/storageDomains

POST /ovirt-engine/api/storageDomains

Copy to Clipboard

Toggle word wrap

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

<storage_domain>
  <name>mydata</name>
  <type>data</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

<storage_domain>
  <name>mydata</name>
  <type>data</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

Copy to Clipboard

Toggle word wrap

新しい NFS ISO ストレージドメインを作成するには、次のような要求を送信します。

<storage_domain>
  <name>myisos</name>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/export/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

<storage_domain>
  <name>myisos</name>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/export/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

Copy to Clipboard

Toggle word wrap

新しい iSCSI ストレージドメインを作成するには、次のような要求を送信します。

<storage_domain>
  <name>myiscsi</name>
  <type>data</type>
  <storage>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="3600144f09dbd050000004eedbd340001"/>
      <logical_unit id="3600144f09dbd050000004eedbd340002"/>
    </logical_units>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

<storage_domain>
  <name>myiscsi</name>
  <type>data</type>
  <storage>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="3600144f09dbd050000004eedbd340001"/>
      <logical_unit id="3600144f09dbd050000004eedbd340002"/>
    </logical_units>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

Copy to Clipboard

Toggle word wrap

Expand

表6.664 パラメーターの概要
名前	型	方向	Summary
`storage_domain`	StorageDomain	In/Out	追加するストレージドメイン

6.218.2. list GET
リンクのコピー

システム内のストレージドメインのリストを返します。

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

Expand

表6.665 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	検索時に大文字と小文字の区別が考慮されるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すストレージドメインの最大数を設定します。
`search`	String	In	返されるストレージドメインを制限するために使用されるクエリー文字列。
`storage_domains`	StorageDomain[]	Out	システム内のストレージドメインのリスト。

6.218.2.1. case_sensitive
リンクのコピー

検索時に大文字と小文字の区別が考慮されるかどうかを示します。デフォルト値は true です。つまり、大文字と小文字の区別が考慮されます。大文字小文字を無視して検索したい場合は、false を設定します。

6.218.2.2. follow
リンクのコピー

6.218.2.3. max
リンクのコピー

返すストレージドメインの最大数を設定します。指定されていない場合は、すべてのストレージドメインが返されます。

6.219. StorageServerConnection
リンクのコピー

Expand

表6.666 メソッドの概要
名前	Summary
`get`
`remove`	ストレージ接続を削除します。
`update`	ストレージ接続を更新します。

6.219.1. get GET
リンクのコピー

Expand

表6.667 パラメーターの概要
名前	型	方向	Summary
`conection`	StorageConnection	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.219.1.1. follow
リンクのコピー

6.219.2. remove DELETE
リンクのコピー

ストレージ接続を削除します。

ストレージ接続は、ストレージドメインも LUN ディスクも参照していない場合にのみ削除できます。ホスト名または ID はオプションです。それを提供すると、そのホストからの接続が切断 (アンマウント) されます。

Expand

表6.668 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。
`host`	String	In	接続がアンマウント (切断) されるホストの名前または識別子。

6.219.2.1. host
リンクのコピー

接続がアンマウント (切断) されるホストの名前または識別子。指定しない場合、ホストは切断されません。

たとえば、識別子 456 のホストを使用して、識別子 123 のストレージ接続を削除するには、以下のようなリクエストを送信します。

DELETE /ovirt-engine/api/storageconnections/123?host=456

DELETE /ovirt-engine/api/storageconnections/123?host=456

Copy to Clipboard

Toggle word wrap

6.219.3. update PUT
リンクのコピー

ストレージ接続を更新します。

たとえば、NFS ストレージサーバーのアドレスを変更するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/storageconnections/123

PUT /ovirt-engine/api/storageconnections/123

Copy to Clipboard

Toggle word wrap

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

<storage_connection>
  <address>mynewnfs.example.com</address>
</storage_connection>

<storage_connection>
  <address>mynewnfs.example.com</address>
</storage_connection>

Copy to Clipboard

Toggle word wrap

iSCSI ストレージサーバーの接続を変更するには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/storageconnections/123

PUT /ovirt-engine/api/storageconnections/123

Copy to Clipboard

Toggle word wrap

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

<storage_connection>
  <port>3260</port>
  <target>iqn.2017-01.com.myhost:444</target>
</storage_connection>

<storage_connection>
  <port>3260</port>
  <target>iqn.2017-01.com.myhost:444</target>
</storage_connection>

Copy to Clipboard

Toggle word wrap

Expand

表6.669 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`connection`	StorageConnection	In/Out
`force`	ブール値	In	関連するストレージドメインのステータスに関係なく、操作が成功するかどうかを示します。

6.219.3.1. force
リンクのコピー

関連するストレージドメインのステータスに関係なく、操作が成功するかどうかを示します (つまり、ストレージドメインのステータスがメンテナンスではない場合にも更新が適用されます)。

このパラメーターはオプションであり、デフォルト値は false です。

6.220. StorageServerConnectionExtension
リンクのコピー

Expand

表6.670 メソッドの概要
名前	Summary
`get`
`remove`
`update`	指定されたホストのストレージサーバー接続エクステンションを更新します。

6.220.1. get GET
リンクのコピー

Expand

表6.671 パラメーターの概要
名前	型	方向	Summary
`extension`	StorageConnectionExtension	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.220.1.1. follow
リンクのコピー

6.220.2. remove DELETE
リンクのコピー

Expand

表6.672 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.220.3. update PUT
リンクのコピー

指定されたホストのストレージサーバー接続エクステンションを更新します。

ホスト 123 のストレージ接続 456 を更新するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456

PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456

Copy to Clipboard

Toggle word wrap

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

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>

Copy to Clipboard

Toggle word wrap

Expand

表6.673 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`extension`	StorageConnectionExtension	In/Out

6.221. StorageServerConnectionExtensions
リンクのコピー

Expand

表6.674 メソッドの概要
名前	Summary
`add`	指定されたホストの新しいストレージサーバー接続エクステンションを作成します。
`list`	ストレージ接続エクステンションのリストを返します。

6.221.1. add POST
リンクのコピー

指定されたホストの新しいストレージサーバー接続エクステンションを作成します。

このエクステンションにより、ユーザーは特定のホストの iSCSI ターゲットのクレデンシャルを定義できます。たとえば、ホスト 123 から iSCSI ターゲットに接続するときに myuser および mypassword をクレデンシャルとして使用するには、次のような要求を送信します。

POST /ovirt-engine/api/hosts/123/storageconnectionextensions

POST /ovirt-engine/api/hosts/123/storageconnectionextensions

Copy to Clipboard

Toggle word wrap

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

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>

Copy to Clipboard

Toggle word wrap

Expand

表6.675 パラメーターの概要
名前	型	方向	Summary
`extension`	StorageConnectionExtension	In/Out

6.221.2. list GET
リンクのコピー

ストレージ接続エクステンションのリストを返します。

返されるストレージ接続のリストの順序は保証されません。

Expand

表6.676 パラメーターの概要
名前	型	方向	Summary
`extensions`	StorageConnectionExtension[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すエクステンションの最大数を設定します。

6.221.2.1. follow
リンクのコピー

6.221.2.2. max
リンクのコピー

返すエクステンションの最大数を設定します。指定されていない場合は、すべてのエクステンションが返されます。

6.222. StorageServerConnections
リンクのコピー

Expand

表6.677 メソッドの概要
名前	Summary
`add`	新しいストレージ接続を作成します。
`list`	ストレージ接続のリストを返します。

6.222.1. add POST
リンクのコピー

新しいストレージ接続を作成します。

たとえば、NFS サーバー mynfs.example.com と NFS 共有 /export/mydata の新しいストレージ接続を作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/storageconnections

POST /ovirt-engine/api/storageconnections

Copy to Clipboard

Toggle word wrap

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

<storage_connection>
  <type>nfs</type>
  <address>mynfs.example.com</address>
  <path>/export/mydata</path>
  <host>
    <name>myhost</name>
  </host>
</storage_connection>

<storage_connection>
  <type>nfs</type>
  <address>mynfs.example.com</address>
  <path>/export/mydata</path>
  <host>
    <name>myhost</name>
  </host>
</storage_connection>

Copy to Clipboard

Toggle word wrap

Expand

表6.678 パラメーターの概要
名前	型	方向	Summary
`connection`	StorageConnection	In/Out

6.222.2. list GET
リンクのコピー

ストレージ接続のリストを返します。

返される接続リストの順序は保証されません。

Expand

表6.679 パラメーターの概要
名前	型	方向	Summary
`connections`	StorageConnection[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す接続の最大数を設定します。

6.222.2.1. follow
リンクのコピー

6.222.2.2. max
リンクのコピー

返す接続の最大数を設定します。指定しない場合、すべての接続が返されます。

6.223. システム
リンクのコピー

Expand

表6.680 メソッドの概要
名前	Summary
`get`	製品名、バージョン番号、関連オブジェクト数の概要など、API を説明する基本情報を返します。
`reloadconfigurations`

6.223.1. get GET
リンクのコピー

製品名、バージョン番号、関連オブジェクト数の概要など、API を説明する基本情報を返します。

GET /ovirt-engine/api

GET /ovirt-engine/api

Copy to Clipboard

Toggle word wrap

次の応答が得られます。

<api>
  <link rel="capabilities" href="/api/capabilities"/>
  <link rel="clusters" href="/api/clusters"/>
  <link rel="clusters/search" href="/api/clusters?search={query}"/>
  <link rel="datacenters" href="/api/datacenters"/>
  <link rel="datacenters/search" href="/api/datacenters?search={query}"/>
  <link rel="events" href="/api/events"/>
  <link rel="events/search" href="/api/events?search={query}"/>
  <link rel="hosts" href="/api/hosts"/>
  <link rel="hosts/search" href="/api/hosts?search={query}"/>
  <link rel="networks" href="/api/networks"/>
  <link rel="roles" href="/api/roles"/>
  <link rel="storagedomains" href="/api/storagedomains"/>
  <link rel="storagedomains/search" href="/api/storagedomains?search={query}"/>
  <link rel="tags" href="/api/tags"/>
  <link rel="templates" href="/api/templates"/>
  <link rel="templates/search" href="/api/templates?search={query}"/>
  <link rel="users" href="/api/users"/>
  <link rel="groups" href="/api/groups"/>
  <link rel="domains" href="/api/domains"/>
  <link rel="vmpools" href="/api/vmpools"/>
  <link rel="vmpools/search" href="/api/vmpools?search={query}"/>
  <link rel="vms" href="/api/vms"/>
  <link rel="vms/search" href="/api/vms?search={query}"/>
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>4</build>
      <full_version>4.0.4</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="/ovirt-engine/api/templates/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
    <root_tag href="/ovirt-engine/api/tags/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
  </special_objects>
  <summary>
    <hosts>
      <active>0</active>
      <total>0</total>
    </hosts>
    <storage_domains>
      <active>0</active>
      <total>1</total>
    </storage_domains>
    <users>
      <active>1</active>
      <total>1</total>
    </users>
    <vms>
      <active>0</active>
      <total>0</total>
    </vms>
  </summary>
  <time>2016-09-14T12:00:48.132+02:00</time>
</api>

<api>
  <link rel="capabilities" href="/api/capabilities"/>
  <link rel="clusters" href="/api/clusters"/>
  <link rel="clusters/search" href="/api/clusters?search={query}"/>
  <link rel="datacenters" href="/api/datacenters"/>
  <link rel="datacenters/search" href="/api/datacenters?search={query}"/>
  <link rel="events" href="/api/events"/>
  <link rel="events/search" href="/api/events?search={query}"/>
  <link rel="hosts" href="/api/hosts"/>
  <link rel="hosts/search" href="/api/hosts?search={query}"/>
  <link rel="networks" href="/api/networks"/>
  <link rel="roles" href="/api/roles"/>
  <link rel="storagedomains" href="/api/storagedomains"/>
  <link rel="storagedomains/search" href="/api/storagedomains?search={query}"/>
  <link rel="tags" href="/api/tags"/>
  <link rel="templates" href="/api/templates"/>
  <link rel="templates/search" href="/api/templates?search={query}"/>
  <link rel="users" href="/api/users"/>
  <link rel="groups" href="/api/groups"/>
  <link rel="domains" href="/api/domains"/>
  <link rel="vmpools" href="/api/vmpools"/>
  <link rel="vmpools/search" href="/api/vmpools?search={query}"/>
  <link rel="vms" href="/api/vms"/>
  <link rel="vms/search" href="/api/vms?search={query}"/>
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>4</build>
      <full_version>4.0.4</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="/ovirt-engine/api/templates/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
    <root_tag href="/ovirt-engine/api/tags/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
  </special_objects>
  <summary>
    <hosts>
      <active>0</active>
      <total>0</total>
    </hosts>
    <storage_domains>
      <active>0</active>
      <total>1</total>
    </storage_domains>
    <users>
      <active>1</active>
      <total>1</total>
    </users>
    <vms>
      <active>0</active>
      <total>0</total>
    </vms>
  </summary>
  <time>2016-09-14T12:00:48.132+02:00</time>
</api>

Copy to Clipboard

Toggle word wrap

エントリーポイントは、仮想化環境のコレクションへのリンクをユーザーに提供します。各コレクションリンクの rel 属性は、各リンクの参照ポイントを提供します。

エントリーポイントには、product_info、special_objects、および summary などの他のデータも含まれます。

Expand

表6.681 パラメーターの概要
名前	型	方向	Summary
`api`	Api	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.223.1.1. follow
リンクのコピー

6.223.2. reloadconfigurations POST
リンクのコピー

Expand

表6.682 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リロードを非同期で実行する必要があるかどうかを示します。

6.224. SystemOption
リンクのコピー

システムの特定の設定オプションの値を提供するサービス。

Expand

表6.683 メソッドの概要
名前	Summary
`get`	特定の設定オプションの値を取得します。

6.224.1. get GET
リンクのコピー

特定の設定オプションの値を取得します。

たとえば、設定オプション MigrationPolicies の値を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/options/MigrationPolicies

GET /ovirt-engine/api/options/MigrationPolicies

Copy to Clipboard

Toggle word wrap

そのリクエストに対する応答は以下のようになります。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<system_option href="/ovirt-engine/api/options/MigrationPolicies" id="MigrationPolicies">
    <name>MigrationPolicies</name>
    <values>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.2</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.3</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.4</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.5</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.6</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.7</version>
        </system_option_value>
    </values>
</system_option>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<system_option href="/ovirt-engine/api/options/MigrationPolicies" id="MigrationPolicies">
    <name>MigrationPolicies</name>
    <values>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.2</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.3</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.4</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.5</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.6</version>
        </system_option_value>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.7</version>
        </system_option_value>
    </values>
</system_option>

Copy to Clipboard

Toggle word wrap

注記

設定オプションをクエリーするには、適切な権限が必要です。一部のオプションは、管理者権限を持つユーザーのみがクエリーできます。

重要

後方互換性はなく、オプションの名前または値の保証もありません。オプションは削除でき、その意味はいつでも変更することができます。

エンジンと同時にリリースされるアプリケーション以外では、このサービスを使用しないことを強く推奨します。他のアプリケーションでの使用はサポートされていません。したがって、アクセス可能な設定オプションを記載したドキュメントはありません。

Expand

表6.684 パラメーターの概要
名前	型	方向	Summary
`option`	SystemOption	Out	システムの返された設定オプション。
`version`	String	In	設定オプションの特定のバージョンのみを返す必要があることを指定するオプションのバージョンパラメーター。

6.224.1.1. version
リンクのコピー

設定オプションの特定のバージョンのみを返す必要があることを指定するオプションのバージョンパラメーター。このパラメーターが使用されない場合は、すべてのバージョンが返されます。

たとえば、バージョン 4.2 のみの MigrationPolicies オプションの値を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/options/MigrationPolicies?version=4.2

GET /ovirt-engine/api/options/MigrationPolicies?version=4.2

Copy to Clipboard

Toggle word wrap

その要求に対する応答は以下のようになります。

<system_option href="/ovirt-engine/api/options/MigrationPolicies" id="MigrationPolicies">
    <name>MigrationPolicies</name>
    <values>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.2</version>
        </system_option_value>
    </values>
</system_option>

<system_option href="/ovirt-engine/api/options/MigrationPolicies" id="MigrationPolicies">
    <name>MigrationPolicies</name>
    <values>
        <system_option_value>
            <value>[{"id":{"uuid":"80554327-0569-496b-bdeb-fcbbf52b827b"},...}]</value>
            <version>4.2</version>
        </system_option_value>
    </values>
</system_option>

Copy to Clipboard

Toggle word wrap

6.225. SystemOptions
リンクのコピー

システムの設定オプションの値を提供するサービス。

6.226. SystemPermissions
リンクのコピー

このサービスは新しいメソッドを追加しません。これは、システムオブジェクトに割り当てられたパーミッションを管理するリソースのパスを指定するアノテーションのプレースホルダーに過ぎません。

Expand

表6.685 メソッドの概要
名前	Summary
`add`	特定のエンティティーのユーザーまたはグループに新しいパーミッションを割り当てます。
`list`	特定のエンティティーのすべてのパーミッションをリスト表示します。

6.226.1. add POST
リンクのコピー

特定のエンティティーのユーザーまたはグループに新しいパーミッションを割り当てます。

たとえば、UserVmManager ロールを ID が 123 の仮想マシン、id が 456 のユーザーに割り当てるには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/permissions

POST /ovirt-engine/api/vms/123/permissions

Copy to Clipboard

Toggle word wrap

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

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>

Copy to Clipboard

Toggle word wrap

id が 456 のユーザーに SuperUser ロールを割り当てるには、以下のように要求を送信します。

POST /ovirt-engine/api/permissions

POST /ovirt-engine/api/permissions

Copy to Clipboard

Toggle word wrap

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

<permission>
  <role>
    <name>SuperUser</name>
  </role>
  <user id="456"/>
</permission>

<permission>
  <role>
    <name>SuperUser</name>
  </role>
  <user id="456"/>
</permission>

Copy to Clipboard

Toggle word wrap

POST /ovirt-engine/api/clusters/123/permissions

POST /ovirt-engine/api/clusters/123/permissions

Copy to Clipboard

Toggle word wrap

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

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>

Copy to Clipboard

Toggle word wrap

Expand

表6.686 パラメーターの概要
名前	型	方向	Summary
`permission`	Permission	In/Out	パーミッション。

6.226.2. list GET
リンクのコピー

特定のエンティティーのすべてのパーミッションをリスト表示します。

たとえば、id 123 のクラスターのすべての権限をリスト表示するには、以下のように要求を送信します。

GET /ovirt-engine/api/clusters/123/permissions

GET /ovirt-engine/api/clusters/123/permissions

Copy to Clipboard

Toggle word wrap

<permissions>
  <permission id="456">
    <cluster id="123"/>
    <role id="789"/>
    <user id="451"/>
  </permission>
  <permission id="654">
    <cluster id="123"/>
    <role id="789"/>
    <group id="127"/>
  </permission>
</permissions>

<permissions>
  <permission id="456">
    <cluster id="123"/>
    <role id="789"/>
    <user id="451"/>
  </permission>
  <permission id="654">
    <cluster id="123"/>
    <role id="789"/>
    <group id="127"/>
  </permission>
</permissions>

Copy to Clipboard

Toggle word wrap

返されるパーミッションの順序は保証されません。

Expand

表6.687 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`permissions`	Permission[]	Out	パーミッションのリスト

6.226.2.1. follow
リンクのコピー

6.227. タグ
リンクのコピー

システム内の特定のタグを管理するサービス。

Expand

表6.688 メソッドの概要
名前	Summary
`get`	タグに関する情報を取得します。
`remove`	システムからタグを削除します。
`update`	タグエンティティーを更新します。

6.227.1. get GET
リンクのコピー

タグに関する情報を取得します。

たとえば、ID 123 のタグに関する情報を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/tags/123

GET /ovirt-engine/api/tags/123

Copy to Clipboard

Toggle word wrap

<tag href="/ovirt-engine/api/tags/123" id="123">
  <name>root</name>
  <description>root</description>
</tag>

<tag href="/ovirt-engine/api/tags/123" id="123">
  <name>root</name>
  <description>root</description>
</tag>

Copy to Clipboard

Toggle word wrap

Expand

表6.689 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`tag`	タグ	Out	タグ。

6.227.1.1. follow
リンクのコピー

6.227.2. remove DELETE
リンクのコピー

システムからタグを削除します。

たとえば、ID 123 のタグを削除するには、以下のようなリクエストを送信します。

DELETE /ovirt-engine/api/tags/123

DELETE /ovirt-engine/api/tags/123

Copy to Clipboard

Toggle word wrap

Expand

表6.690 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.227.3. update PUT
リンクのコピー

タグエンティティーを更新します。

たとえば、親タグを ID 123 のタグの ID 456 のタグに更新するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/tags/123

PUT /ovirt-engine/api/tags/123

Copy to Clipboard

Toggle word wrap

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

<tag>
  <parent id="456"/>
</tag>

<tag>
  <parent id="456"/>
</tag>

Copy to Clipboard

Toggle word wrap

ID の代わりにタグ名を指定することもできます。たとえば、親タグを ID 123 のタグの mytag という名前のタグに更新するには、以下のようなリクエストを送信します。

<tag>
  <parent>
    <name>mytag</name>
  </parent>
</tag>

<tag>
  <parent>
    <name>mytag</name>
  </parent>
</tag>

Copy to Clipboard

Toggle word wrap

Expand

表6.691 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`tag`	タグ	In/Out	更新されたタグ。

6.228. タグ
リンクのコピー

システム内のタグのコレクションを管理するサービスを表します。

Expand

表6.692 メソッドの概要
名前	Summary
`add`	システムに新しいタグを追加します。
`list`	システム内のタグをリスト表示します。

6.228.1. add POST
リンクのコピー

システムに新しいタグを追加します。

たとえば、mytag という名前の新しいタグをシステムに追加するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/tags

POST /ovirt-engine/api/tags

Copy to Clipboard

Toggle word wrap

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

<tag>
  <name>mytag</name>
</tag>

<tag>
  <name>mytag</name>
</tag>

Copy to Clipboard

Toggle word wrap

注記

root タグは、親タグが指定されていない場合にデフォルトの親タグと見なされる特別な疑似タグになります。root タグを削除したり、親タグを割り当てたりすることはできません。

特定の親タグを持つ新しいタグを作成するには、以下のようなリクエスト本文を送信します。

<tag>
  <name>mytag</name>
  <parent>
    <name>myparenttag</name>
  </parent>
</tag>

<tag>
  <name>mytag</name>
  <parent>
    <name>myparenttag</name>
  </parent>
</tag>

Copy to Clipboard

Toggle word wrap

Expand

表6.693 パラメーターの概要
名前	型	方向	Summary
`tag`	タグ	In/Out	追加されたタグ。

6.228.2. list GET
リンクのコピー

システム内のタグをリスト表示します。

たとえば、システム内のタグの完全な階層をリスト表示するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/tags

GET /ovirt-engine/api/tags

Copy to Clipboard

Toggle word wrap

<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>root2</name>
    <description>root2</description>
    <parent href="/ovirt-engine/api/tags/111" id="111"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/333" id="333">
    <name>root3</name>
    <description>root3</description>
    <parent href="/ovirt-engine/api/tags/222" id="222"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/111" id="111">
    <name>root</name>
    <description>root</description>
  </tag>
</tags>

<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>root2</name>
    <description>root2</description>
    <parent href="/ovirt-engine/api/tags/111" id="111"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/333" id="333">
    <name>root3</name>
    <description>root3</description>
    <parent href="/ovirt-engine/api/tags/222" id="222"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/111" id="111">
    <name>root</name>
    <description>root</description>
  </tag>
</tags>

Copy to Clipboard

Toggle word wrap

前の XML 出力では、以下のようなタグの階層を確認できます。

root:        (id: 111)
  - root2    (id: 222)
    - root3  (id: 333)

root:        (id: 111)
  - root2    (id: 222)
    - root3  (id: 333)

Copy to Clipboard

Toggle word wrap

返されるタグリストの順序は保証されません。

Expand

表6.694 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すタグの最大数を設定します。
`tags`	Tag[]	Out	システム内のすべてのタグのリスト。

6.228.2.1. follow
リンクのコピー

6.228.2.2. max
リンクのコピー

返すタグの最大数を設定します。指定されていない場合は、すべてのタグが返されます。

6.229. テンプレート
リンクのコピー

仮想マシンのテンプレートとテンプレートのバージョンを管理します。

Expand

表6.695 メソッドの概要
名前	Summary
`export`	テンプレートをデータセンターのエクスポートドメインにエクスポートします。
`get`	このテンプレートまたはテンプレートバージョンに関する情報を返します。
`remove`	仮想マシンテンプレートを削除します。
`update`	テンプレートを更新します。

6.229.1. export POST
リンクのコピー

テンプレートをデータセンターのエクスポートドメインにエクスポートします。

たとえば、以下のリクエストを送信します。

POST /ovirt-engine/api/templates/123/export

POST /ovirt-engine/api/templates/123/export

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain id="456"/>
  <exclusive>true<exclusive/>
</action>

<action>
  <storage_domain id="456"/>
  <exclusive>true<exclusive/>
</action>

Copy to Clipboard

Toggle word wrap

エンジンのバージョン 4.2 以降、テンプレートを仮想アプライアンス (OVA) としてエクスポートすることも可能となっています。たとえば、テンプレート 123 を、ホスト myhost のディレクトリー /home/ovirt/ に配置される myvm.ova という名前の OVA ファイルとしてエクスポートするには、次のようにします。

POST /ovirt-engine/api/templates/123/export

POST /ovirt-engine/api/templates/123/export

Copy to Clipboard

Toggle word wrap

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

<action>
  <host>
    <name>myhost</name>
  </host>
  <directory>/home/ovirt</directory>
  <filename>myvm.ova</filename>
</action>

<action>
  <host>
    <name>myhost</name>
  </host>
  <directory>/home/ovirt</directory>
  <filename>myvm.ova</filename>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.696 パラメーターの概要
名前	型	方向	Summary
`exclusive`	ブール値	In	同じ名前の既存のテンプレートを上書きする必要があるかどうかを示します。
`storage_domain`	StorageDomain	In	宛先のエクスポートストレージドメインを指定します。

6.229.1.1. exclusive
リンクのコピー

同じ名前の既存のテンプレートを上書きする必要があるかどうかを示します。

宛先ドメインに同じ名前のテンプレートが存在する場合、エクスポートアクションは失敗したアクションを報告します。このパラメーターを true に設定すると、この動作が変更され、既存のテンプレートがすべて上書きされます。

6.229.2. get GET
リンクのコピー

このテンプレートまたはテンプレートバージョンに関する情報を返します。

Expand

表6.697 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`template`	テンプレート	Out	テンプレートまたはテンプレートバージョンに関する情報。

6.229.2.1. follow
リンクのコピー

6.229.3. remove DELETE
リンクのコピー

仮想マシンテンプレートを削除します。

DELETE /ovirt-engine/api/templates/123

DELETE /ovirt-engine/api/templates/123

Copy to Clipboard

Toggle word wrap

Expand

表6.698 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.229.4. update PUT
リンクのコピー

テンプレートを更新します。

name、description、type、memory、cpu、topology、os、high_availability、display、stateless、usb、および timezone 要素は、テンプレートの作成後に更新できます。

たとえば、1 GiB のメモリーを持つようにテンプレートを更新するには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/templates/123

PUT /ovirt-engine/api/templates/123

Copy to Clipboard

Toggle word wrap

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

<template>
  <memory>1073741824</memory>
</template>

<template>
  <memory>1073741824</memory>
</template>

Copy to Clipboard

Toggle word wrap

version_name name 属性は、テンプレートバージョンに使用される version 属性内で更新できる唯一の属性です。

<template>
  <version>
    <version_name>mytemplate_2</version_name>
  </version>
</template>

<template>
  <version>
    <version_name>mytemplate_2</version_name>
  </version>
</template>

Copy to Clipboard

Toggle word wrap

Expand

表6.699 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`template`	テンプレート	In/Out

6.230. TemplateCdrom
リンクのコピー

テンプレートで CD-ROM デバイスを管理するサービス。

Expand

表6.700 メソッドの概要
名前	Summary
`get`	この CDROM デバイスに関する情報を返します。

6.230.1. get GET
リンクのコピー

この CDROM デバイスに関する情報を返します。

たとえば、テンプレート 123 の CD-ROM デバイスに関する情報を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/templates/123/cdroms/

GET /ovirt-engine/api/templates/123/cdroms/

Copy to Clipboard

Toggle word wrap

Expand

表6.701 パラメーターの概要
名前	型	方向	Summary
`cdrom`	Cdrom	Out	CDROM デバイスに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.230.1.1. cdrom
リンクのコピー

CDROM デバイスに関する情報。

情報は、CD-ROM デバイス、テンプレート、およびオプションで挿入されたディスクへの参照を含む cdrom 属性で構成されています。

ディスクが挿入されている場合は、file 属性には ISO イメージへの参照が含まれます。

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
  <file id="mycd.iso"/>
</cdrom>

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
  <file id="mycd.iso"/>
</cdrom>

Copy to Clipboard

Toggle word wrap

ディスクが挿入されていない場合は、file 属性は報告されません。

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
</cdrom>

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
</cdrom>

Copy to Clipboard

Toggle word wrap

6.230.1.2. follow
リンクのコピー

6.231. TemplateCdroms
リンクのコピー

テンプレートの CD-ROM デバイスをリスト表示します。

Expand

表6.702 メソッドの概要
名前	Summary
`list`	テンプレートの CD-ROM デバイスのリストを返します。

6.231.1. list GET
リンクのコピー

テンプレートの CD-ROM デバイスのリストを返します。

返される CD-ROM デバイスリストの順序は保証されません。

Expand

表6.703 パラメーターの概要
名前	型	方向	Summary
`cdroms`	Cdrom[]	Out	テンプレートの CD-ROM デバイスのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す CD-ROM の最大数を設定します。

6.231.1.1. follow
リンクのコピー

6.231.1.2. max
リンクのコピー

返す CD-ROM の最大数を設定します。指定されていない場合は、すべての CD-ROM が返されます。

6.232. TemplateDisk
リンクのコピー

Expand

表6.704 メソッドの概要
名前	Summary
`copy`	テンプレートにアタッチされた指定のディスクを特定のストレージドメインにコピーします。
`export`
`get`
`remove`

6.232.1. copy POST
リンクのコピー

テンプレートにアタッチされた指定のディスクを特定のストレージドメインにコピーします。

Expand

表6.705 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	コピーを非同期的に実行するかどうかを指定します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`storage_domain`	StorageDomain	In

6.232.2. export POST
リンクのコピー

Expand

表6.706 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	エクスポートを非同期で実行する必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`storage_domain`	StorageDomain	In

6.232.3. get GET
リンクのコピー

Expand

表6.707 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.232.3.1. follow
リンクのコピー

6.232.4. remove DELETE
リンクのコピー

Expand

表6.708 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.233. TemplateDiskAttachment
リンクのコピー

このサービスは、テンプレートへのディスクの割り当てを管理します。

Expand

表6.709 メソッドの概要
名前	Summary
`get`	アタッチメントの詳細を返します。
`remove`	テンプレートからディスクを削除します。

6.233.1. get GET
リンクのコピー

アタッチメントの詳細を返します。

Expand

表6.710 パラメーターの概要
名前	型	方向	Summary
`attachment`	DiskAttachment	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.233.1.1. follow
リンクのコピー

6.233.2. remove DELETE
リンクのコピー

テンプレートからディスクを削除します。ディスクは、他のストレージドメインにディスクのコピーが存在する場合にのみ削除されます。

どのコピーを削除するかを決定するには、ストレージドメインを指定する必要があります (テンプレートディスクは複数のストレージドメインにコピーを持つことができます)。

DELETE /ovirt-engine/api/templates/{template:id}/diskattachments/{attachment:id}?storage_domain=072fbaa1-08f3-4a40-9f34-a5ca22dd1d74

DELETE /ovirt-engine/api/templates/{template:id}/diskattachments/{attachment:id}?storage_domain=072fbaa1-08f3-4a40-9f34-a5ca22dd1d74

Copy to Clipboard

Toggle word wrap

Expand

表6.711 パラメーターの概要
名前	型	方向	Summary
`force`	ブール値	In
`storage_domain`	String	In	削除するイメージが存在するストレージドメインの識別子を指定します。

6.234. TemplateDiskAttachments
リンクのコピー

このサービスは、テンプレートに割り当てられた一連のディスクを管理します。アタッチされた各ディスクは、DiskAttachment で表されます。

Expand

表6.712 メソッドの概要
名前	Summary
`list`	テンプレートにアタッチされているディスクをリスト表示します。

6.234.1. list GET
リンクのコピー

テンプレートにアタッチされているディスクをリスト表示します。

返されるアタッチメントリストの順序は保証されません。

Expand

表6.713 パラメーターの概要
名前	型	方向	Summary
`attachments`	DiskAttachment[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.234.1.1. follow
リンクのコピー

6.235. TemplateDisks
リンクのコピー

Expand

表6.714 メソッドの概要
名前	Summary
`list`	テンプレートのディスクのリストを返します。

6.235.1. list GET
リンクのコピー

テンプレートのディスクのリストを返します。

返されるフックリストの順序は保証されません。

Expand

表6.715 パラメーターの概要
名前	型	方向	Summary
`disks`	Disk[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。

6.235.1.1. follow
リンクのコピー

6.235.1.2. max
リンクのコピー

返すディスクの最大数を設定します。指定しない場合、すべてのディスクが返されます。

6.236. TemplateGraphicsConsole
リンクのコピー

Expand

表6.716 メソッドの概要
名前	Summary
`get`	テンプレートのグラフィックコンソール設定を取得します。
`remove`	テンプレートからグラフィックコンソールを削除します。

6.236.1. get GET
リンクのコピー

テンプレートのグラフィックコンソール設定を取得します。

Expand

表6.717 パラメーターの概要
名前	型	方向	Summary
`console`	GraphicsConsole	Out	テンプレートのグラフィックコンソールに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.236.1.1. follow
リンクのコピー

6.236.2. remove DELETE
リンクのコピー

テンプレートからグラフィックコンソールを削除します。

Expand

表6.718 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.237. TemplateGraphicsConsoles
リンクのコピー

Expand

表6.719 メソッドの概要
名前	Summary
`add`	テンプレートに新しいグラフィックコンソールを追加します。
`list`	テンプレートの設定済みグラフィックコンソールをすべてリスト表示します。

6.237.1. add POST
リンクのコピー

テンプレートに新しいグラフィックコンソールを追加します。

Expand

表6.720 パラメーターの概要
名前	型	方向	Summary
`console`	GraphicsConsole	In/Out

6.237.2. list GET
リンクのコピー

テンプレートの設定済みグラフィックコンソールをすべてリスト表示します。

返されるグラフィックコンソールリストの順序は保証されません。

Expand

表6.721 パラメーターの概要
名前	型	方向	Summary
`consoles`	GraphicsConsole[]	Out	テンプレートのグラフィックコンソールのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すコンソールの最大数を設定します。

6.237.2.1. follow
リンクのコピー

6.237.2.2. max
リンクのコピー

返すコンソールの最大数を設定します。指定しない場合、すべてのコンソールが返されます。

6.238. TemplateMediatedDevice
リンクのコピー

Expand

表6.722 メソッドの概要
名前	Summary
`get`	テンプレートの仲介デバイスの設定を取得します。
`remove`	仲介デバイスをテンプレートから削除します。
`update`	仲介デバイスに関する情報を更新します。

6.238.1. get GET
リンクのコピー

テンプレートの仲介デバイスの設定を取得します。

Expand

表6.723 パラメーターの概要
名前	型	方向	Summary
`device`	VmMediatedDevice	Out	テンプレートの仲介デバイスに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.238.1.1. follow
リンクのコピー

6.238.2. remove DELETE
リンクのコピー

仲介デバイスをテンプレートから削除します。

Expand

表6.724 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.238.3. update PUT
リンクのコピー

仲介デバイスに関する情報を更新します。

specParams 要素を使用して情報を更新できます。

たとえば、仲介デバイスを更新するには、次のような要求を送信します。

PUT /ovirt-engine/api/templates/123/mediateddevices/00000000-0000-0000-0000-000000000000
<vm_mediated_device>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

PUT /ovirt-engine/api/templates/123/mediateddevices/00000000-0000-0000-0000-000000000000
<vm_mediated_device>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

Copy to Clipboard

Toggle word wrap

応答本文を使用:

<vm_mediated_device href="/ovirt-engine/api/templates/123/mediateddevices/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

<vm_mediated_device href="/ovirt-engine/api/templates/123/mediateddevices/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

Copy to Clipboard

Toggle word wrap

Expand

表6.725 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`devices`	VmMediatedDevice	In/Out	仲介デバイスに関する情報。

6.238.3.1. devices
リンクのコピー

仲介デバイスに関する情報。

リクエストデータには specParams プロパティーが含まれている必要があります。応答データには、更新された仲介デバイスに関する完全な情報が含まれています。

6.239. TemplateMediatedDevices
リンクのコピー

テンプレートの仲介デバイスを管理するサービス。

Expand

表6.726 メソッドの概要
名前	Summary
`add`	テンプレートに新しい仲介デバイスを追加します。
`list`	テンプレートの設定済み仲介デバイスをすべてリストします。

6.239.1. add POST
リンクのコピー

テンプレートに新しい仲介デバイスを追加します。

Expand

表6.727 パラメーターの概要
名前	型	方向	Summary
`device`	VmMediatedDevice	In/Out

6.239.2. list GET
リンクのコピー

テンプレートの設定済み仲介デバイスをすべてリストします。

返される仲介デバイスリストの順序は保証されません。

Expand

表6.728 パラメーターの概要
名前	型	方向	Summary
`devices`	VmMediatedDevice[]	Out	テンプレートの仲介デバイスのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す仲介デバイスの最大数を設定します。

6.239.2.1. follow
リンクのコピー

6.239.2.2. max
リンクのコピー

返す仲介デバイスの最大数を設定します。指定されていない場合は、すべての仲介デバイスが返されます。

6.240. TemplateNic
リンクのコピー

Expand

表6.729 メソッドの概要
名前	Summary
`get`
`remove`
`update`	テンプレートに割り当てられている指定のネットワークインターフェイスカードを更新します。

6.240.1. get GET
リンクのコピー

Expand

表6.730 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`nic`	Nic	Out

6.240.1.1. follow
リンクのコピー

6.240.2. remove DELETE
リンクのコピー

Expand

表6.731 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.240.3. update PUT
リンクのコピー

テンプレートに割り当てられている指定のネットワークインターフェイスカードを更新します。

Expand

表6.732 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`nic`	Nic	In/Out

6.241. TemplateNics
リンクのコピー

Expand

表6.733 メソッドの概要
名前	Summary
`add`	テンプレートに新しいネットワークインターフェイスカードを追加します。
`list`	テンプレートの NIC のリストを返します。

6.241.1. add POST
リンクのコピー

テンプレートに新しいネットワークインターフェイスカードを追加します。

Expand

表6.734 パラメーターの概要
名前	型	方向	Summary
`nic`	Nic	In/Out

6.241.2. list GET
リンクのコピー

テンプレートの NIC のリストを返します。

返される NIC リストの順序は保証されません。

Expand

表6.735 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す NIC の最大数を設定します。
`nics`	Nic[]	Out

6.241.2.1. follow
リンクのコピー

6.241.2.2. max
リンクのコピー

返す NIC の最大数を設定します。指定されていない場合は、すべての NIC が返されます。

6.242. TemplateWatchdog
リンクのコピー

Expand

表6.736 メソッドの概要
名前	Summary
`get`
`remove`
`update`	指定された ID で識別されるテンプレートのウォッチドッグを更新します。

6.242.1. get GET
リンクのコピー

Expand

表6.737 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`watchdog`	Watchdog	Out

6.242.1.1. follow
リンクのコピー

6.242.2. remove DELETE
リンクのコピー

Expand

表6.738 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.242.3. update PUT
リンクのコピー

指定された ID で識別されるテンプレートのウォッチドッグを更新します。

Expand

表6.739 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`watchdog`	Watchdog	In/Out

6.243. TemplateWatchdogs
リンクのコピー

Expand

表6.740 メソッドの概要
名前	Summary
`add`	指定された ID で識別されるテンプレートにウォッチドッグを追加します。
`list`	ウォッチドッグのリストを返します。

6.243.1. add POST
リンクのコピー

指定された ID で識別されるテンプレートにウォッチドッグを追加します。

Expand

表6.741 パラメーターの概要
名前	型	方向	Summary
`watchdog`	Watchdog	In/Out

6.243.2. list GET
リンクのコピー

ウォッチドッグのリストを返します。

返されるウォッチドッグリストの順序は保証されません。

Expand

表6.742 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すウォッチドッグの最大数を設定します。
`watchdogs`	Watchdog[]	Out

6.243.2.1. follow
リンクのコピー

6.243.2.2. max
リンクのコピー

返すウォッチドッグの最大数を設定します。指定しない場合、すべてのウォッチドッグが返されます。

6.244. テンプレート
リンクのコピー

このサービスは、システムで使用可能な仮想マシンテンプレートを管理します。

Expand

表6.743 メソッドの概要
名前	Summary
`add`	新しいテンプレートを作成します。
`list`	仮想マシンテンプレートのリストを返します。

6.244.1. add POST
リンクのコピー

新しいテンプレートを作成します。

これには、name 要素と vm 要素が必要です。仮想マシンを識別するには、vm.id または vm.name 属性を使用します。たとえば、識別子が 123 の仮想マシンからテンプレートを作成するには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/templates

POST /ovirt-engine/api/templates

Copy to Clipboard

Toggle word wrap

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

<template>
  <name>mytemplate</name>
  <vm id="123"/>
</template>

<template>
  <name>mytemplate</name>
  <vm id="123"/>
</template>

Copy to Clipboard

Toggle word wrap

バージョン 4.3 以降、スナップショットから仮想マシンテンプレートを作成するには、以下のようなリクエスト本文を送信します。

<template>
  <name>mytemplate</name>
  <vm id="123">
    <snapshots>
      <snapshot id="456"/>
    </snapshots>
  </vm>
</template>

<template>
  <name>mytemplate</name>
  <vm id="123">
    <snapshots>
      <snapshot id="456"/>
    </snapshots>
  </vm>
</template>

Copy to Clipboard

Toggle word wrap

テンプレートのディスクをカスタマイズして、元の仮想マシンのディスクとは異なる特性を作成できます。これを行うには、vm.disk_attachments 属性を使用し、元の仮想マシンのディスクの識別子と変更する特性を指定します。たとえば、元の仮想マシンに識別子 456 のディスクがあり、そのディスクの名前を mydisk に、フォーマットを Copy On Write に変更して sparse にする場合は、次のようなリクエスト本文を送信します。

<template>
  <name>mytemplate</name>
  <vm id="123">
    <disk_attachments>
      <disk_attachment>
        <disk id="456">
          <name>mydisk</name>
          <format>cow</format>
          <sparse>true</sparse>
        </disk>
      </disk_attachment>
    </disk_attachments>
  </vm>
</template>

<template>
  <name>mytemplate</name>
  <vm id="123">
    <disk_attachments>
      <disk_attachment>
        <disk id="456">
          <name>mydisk</name>
          <format>cow</format>
          <sparse>true</sparse>
        </disk>
      </disk_attachment>
    </disk_attachments>
  </vm>
</template>

Copy to Clipboard

Toggle word wrap

テンプレートは、既存テンプレートのサブバージョンとして作成できます。これには、新しいテンプレートの name および vm 属性と、新しいテンプレートバージョンの base_template および version_name 属性が必要です。base_template および version_name 属性は、template セクションにある version セクション内で指定する必要があります。id または name 属性で仮想マシンを識別します。

<template>
  <name>mytemplate</name>
  <vm id="123"/>
  <version>
    <base_template id="456"/>
    <version_name>mytemplate_001</version_name>
  </version>
</template>

<template>
  <name>mytemplate</name>
  <vm id="123"/>
  <version>
    <base_template id="456"/>
    <version_name>mytemplate_001</version_name>
  </version>
</template>

Copy to Clipboard

Toggle word wrap

テンプレートの宛先ストレージドメインは、次の 2 つのいずれかの方法でカスタマイズできます。

リクエストレベルでグローバルにカスタマイズします。リクエストには、ストレージドメインで作成するディスクアタッチメントをリストする必要があります。ディスクアタッチメントがリストされていない場合、グローバルストレージドメインパラメーターは無視されます。

<template>
  <name>mytemplate</name>
  <storage_domain id="123"/>
  <vm id="456">
    <disk_attachments>
      <disk_attachment>
        <disk id="789">
          <format>cow</format>
          <sparse>true</sparse>
        </disk>
      </disk_attachment>
    </disk_attachments>
  </vm>
</template>

<template>
  <name>mytemplate</name>
  <storage_domain id="123"/>
  <vm id="456">
    <disk_attachments>
      <disk_attachment>
        <disk id="789">
          <format>cow</format>
          <sparse>true</sparse>
        </disk>
      </disk_attachment>
    </disk_attachments>
  </vm>
</template>

Copy to Clipboard

Toggle word wrap

各ディスクアタッチメントごとにカスタマイズします。各ディスクアタッチメントに必要なストレージドメインを指定します。グローバルストレージ定義を指定すると、ディスクアタッチメントごとのストレージドメインの指定が上書きされます。

<template>
  <name>mytemplate</name>
  <vm id="123">
    <disk_attachments>
      <disk_attachment>
        <disk id="456">
          <format>cow</format>
          <sparse>true</sparse>
          <storage_domains>
             <storage_domain id="789"/>
          </storage_domains>
        </disk>
      </disk_attachment>
    </disk_attachments>
  </vm>
</template>

<template>
  <name>mytemplate</name>
  <vm id="123">
    <disk_attachments>
      <disk_attachment>
        <disk id="456">
          <format>cow</format>
          <sparse>true</sparse>
          <storage_domains>
             <storage_domain id="789"/>
          </storage_domains>
        </disk>
      </disk_attachment>
    </disk_attachments>
  </vm>
</template>

Copy to Clipboard

Toggle word wrap

Expand

表6.744 パラメーターの概要
名前	型	方向	Summary
`clone_permissions`	ブール値	In	仮想マシンの権限をテンプレートにコピーするかどうかを指定します。
`seal`	ブール値	In	テンプレートをシールします。
`template`	テンプレート	In/Out	テンプレートまたはテンプレートバージョンに関する情報。

6.244.1.1. clone_permissions
リンクのコピー

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

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

POST /ovirt-engine/api/templates?clone_permissions=true

POST /ovirt-engine/api/templates?clone_permissions=true

Copy to Clipboard

Toggle word wrap

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

<template>
  <name>mytemplate<name>
  <vm>
    <name>myvm<name>
  </vm>
</template>

<template>
  <name>mytemplate<name>
  <vm>
    <name>myvm<name>
  </vm>
</template>

Copy to Clipboard

Toggle word wrap

6.244.1.2. seal
リンクのコピー

テンプレートをシールします。

このオプションのパラメーターが指定され、その値が true の場合、テンプレートは作成後にシールされます。

シーリングは、SSH キー、UDEV ルール、MAC アドレス、システム ID、ホスト名など、すべてのホスト固有の設定をファイルシステムから消去するため、テンプレートを使用して、手動の介入なしで複数の仮想マシンを簡単に作成できます。

現在、シーリングは Linux オペレーティングシステムでのみサポートされています。

6.244.2. list GET
リンクのコピー

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

以下に例を示します。

GET /ovirt-engine/api/templates

GET /ovirt-engine/api/templates

Copy to Clipboard

Toggle word wrap

仮想マシンと仮想マシンテンプレートのリストを返します。

返されるテンプレートリストの順序は保証されません。

Expand

表6.745 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すテンプレートの最大数を設定します。
`search`	String	In	返されたボリュームを制限するために使用されるクエリー文字列です。
`templates`	Template[]	Out	仮想マシンテンプレートのリスト。

6.244.2.1. case_sensitive
リンクのコピー

6.244.2.2. follow
リンクのコピー

6.244.2.3. max
リンクのコピー

返すテンプレートの最大数を設定します。指定されていない場合は、すべてのテンプレートが返されます。

6.245. UnmanagedNetwork
リンクのコピー

Expand

表6.746 メソッドの概要
名前	Summary
`get`
`remove`

6.245.1. get GET
リンクのコピー

Expand

表6.747 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`network`	UnmanagedNetwork	Out

6.245.1.1. follow
リンクのコピー

6.245.2. remove DELETE
リンクのコピー

Expand

表6.748 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.246. UnmanagedNetworks
リンクのコピー

Expand

表6.749 メソッドの概要
名前	Summary
`list`	ホストの管理されていないネットワークのリストを返します。

6.246.1. list GET
リンクのコピー

ホストの管理されていないネットワークのリストを返します。

返されるネットワークリストの順序は保証されません。

Expand

表6.750 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すネットワークの最大数を設定します。
`networks`	UnmanagedNetwork[]	Out

6.246.1.1. follow
リンクのコピー

6.246.1.2. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

6.247. User
リンクのコピー

システム内のユーザーを管理するサービス。このサービスを使用して、ユーザーの詳細を取得するか、ユーザーを削除します。新しいユーザーを追加するには、users を使用してください。

Expand

表6.751 メソッドの概要
名前	Summary
`get`	システムユーザー情報を取得します。
`remove`	システムユーザーを削除します。
`update`	ユーザーに関する情報を更新します。

6.247.1. get GET
リンクのコピー

システムユーザー情報を取得します。

使用方法:

GET /ovirt-engine/api/users/1234

GET /ovirt-engine/api/users/1234

Copy to Clipboard

Toggle word wrap

ユーザー情報を返します。

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
  <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
  <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
  <department></department>
  <domain_entry_id>23456</domain_entry_id>
  <email>user1@domain.com</email>
  <last_name>Lastname</last_name>
  <namespace>*</namespace>
  <principal>user1</principal>
  <user_name>user1@domain-authz</user_name>
  <domain href="/ovirt-engine/api/domains/45678" id="45678">
    <name>domain-authz</name>
  </domain>
</user>

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
  <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
  <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
  <department></department>
  <domain_entry_id>23456</domain_entry_id>
  <email>user1@domain.com</email>
  <last_name>Lastname</last_name>
  <namespace>*</namespace>
  <principal>user1</principal>
  <user_name>user1@domain-authz</user_name>
  <domain href="/ovirt-engine/api/domains/45678" id="45678">
    <name>domain-authz</name>
  </domain>
</user>

Copy to Clipboard

Toggle word wrap

Expand

表6.752 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`user`	User	Out	システムユーザー。

6.247.1.1. follow
リンクのコピー

6.247.2. remove DELETE
リンクのコピー

システムユーザーを削除します。

使用方法:

DELETE /ovirt-engine/api/users/1234

DELETE /ovirt-engine/api/users/1234

Copy to Clipboard

Toggle word wrap

Expand

表6.753 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.247.3. update PUT
リンクのコピー

ユーザーに関する情報を更新します。

user_options フィールドのみを更新できます。

たとえば、ユーザーのオプションを更新する場合は、以下のようになります。

PUT /ovirt-engine/api/users/123

PUT /ovirt-engine/api/users/123

Copy to Clipboard

Toggle word wrap

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

<user>
   <user_options>
      <property>
         <name>test</name>
         <value>["any","JSON"]</value>
      </property>
   </user_options>
</user>

<user>
   <user_options>
      <property>
         <name>test</name>
         <value>["any","JSON"]</value>
      </property>
   </user_options>
</user>

Copy to Clipboard

Toggle word wrap

重要

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

Expand

表6.754 パラメーターの概要
名前	型	方向	Summary
`user`	User	In/Out

6.248. UserOption
リンクのコピー

Expand

表6.755 メソッドの概要
名前	Summary
`get`	JSON 型のユーザープロファイルプロパティーを返します。
`remove`	JSON 型の既存のプロパティーを削除します。

6.248.1. get GET
リンクのコピー

JSON 型のユーザープロファイルプロパティーを返します。

リクエストの例 (識別子 123 のユーザーと識別子 456 のオプションの場合):

GET /ovirt-engine/api/users/123/options/456

GET /ovirt-engine/api/users/123/options/456

Copy to Clipboard

Toggle word wrap

結果は以下の XML ドキュメントになります。

  <user_option href="/ovirt-engine/api/users/123/options/456" id="456">
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </user_option>

  <user_option href="/ovirt-engine/api/users/123/options/456" id="456">
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </user_option>

Copy to Clipboard

Toggle word wrap

Expand

表6.756 パラメーターの概要
名前	型	方向	Summary
`option`	UserOption	Out

6.248.2. remove DELETE
リンクのコピー

JSON 型の既存のプロパティーを削除します。

リクエストの例 (識別子 123 のユーザーと識別子 456 のオプションの場合):

DELETE /ovirt-engine/api/users/123/options/456

DELETE /ovirt-engine/api/users/123/options/456

Copy to Clipboard

Toggle word wrap

6.249. UserOptions
リンクのコピー

Expand

表6.757 メソッドの概要
名前	Summary
`add`	JSON 型の新しいユーザープロファイルプロパティーを追加します。
`list`	タイプ JSON のユーザープロファイルプロパティーのリストを返します。

6.249.1. add POST
リンクのコピー

JSON 型の新しいユーザープロファイルプロパティーを追加します。

リクエストの例 (識別子 123 のユーザーの場合):

POST /ovirt-engine/api/users/123/options

POST /ovirt-engine/api/users/123/options

Copy to Clipboard

Toggle word wrap

Payload:

  <user_option>
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
  </user_option>

  <user_option>
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
  </user_option>

Copy to Clipboard

Toggle word wrap

Expand

表6.758 パラメーターの概要
名前	型	方向	Summary
`option`	UserOption	In/Out

6.249.2. list GET
リンクのコピー

タイプ JSON のユーザープロファイルプロパティーのリストを返します。

リクエストの例 (識別子 123 のユーザーの場合):

GET /ovirt-engine/api/users/123/options

GET /ovirt-engine/api/users/123/options

Copy to Clipboard

Toggle word wrap

結果は以下の XML ドキュメントになります。

<user_options>
  <user_option href="/ovirt-engine/api/users/123/options/456" id="456">
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </user_option>
</user_options>

<user_options>
  <user_option href="/ovirt-engine/api/users/123/options/456" id="456">
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </user_option>
</user_options>

Copy to Clipboard

Toggle word wrap

Expand

表6.759 パラメーターの概要
名前	型	方向	Summary
`オプション`	UserOption[]	Out

6.250. ユーザー
リンクのコピー

システム内のユーザーを管理するサービス。

Expand

表6.760 メソッドの概要
名前	Summary
`add`	ディレクトリーサービスからユーザーを追加します。
`list`	システム内のすべてのユーザーをリスト表示します。

6.250.1. add POST
リンクのコピー

ディレクトリーサービスからユーザーを追加します。

たとえば、myextension-authz 承認プロバイダーから myuser ユーザーを追加するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/users

POST /ovirt-engine/api/users

Copy to Clipboard

Toggle word wrap

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

<user>
  <user_name>myuser@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>

<user>
  <user_name>myuser@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>

Copy to Clipboard

Toggle word wrap

Active Directory を使用している場合は、ユーザープリンシパル名 (UPN) を username として渡し、その後に承認プロバイダー名を渡す必要があります。バグ 1147900 のため、ユーザーの UPN に設定された principal パラメーターも提供する必要があります。

たとえば、UPN myuser@mysubdomain.mydomain.com を持つユーザーを myextension-authz 承認プロバイダーから追加するには、以下のようなリクエスト本文を送信します。

<user>
  <principal>myuser@mysubdomain.mydomain.com</principal>
  <user_name>myuser@mysubdomain.mydomain.com@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>

<user>
  <principal>myuser@mysubdomain.mydomain.com</principal>
  <user_name>myuser@mysubdomain.mydomain.com@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>

Copy to Clipboard

Toggle word wrap

Expand

表6.761 パラメーターの概要
名前	型	方向	Summary
`user`	User	In/Out

6.250.2. list GET
リンクのコピー

システム内のすべてのユーザーをリスト表示します。

使用方法:

GET /ovirt-engine/api/users

GET /ovirt-engine/api/users

Copy to Clipboard

Toggle word wrap

ユーザーのリストを返します。

<users>
  <user href="/ovirt-engine/api/users/1234" id="1234">
    <name>admin</name>
    <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
    <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
    <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
    <domain_entry_id>23456</domain_entry_id>
    <namespace>*</namespace>
    <principal>user1</principal>
    <user_name>user1@domain-authz</user_name>
    <domain href="/ovirt-engine/api/domains/45678" id="45678">
      <name>domain-authz</name>
    </domain>
  </user>
</users>

<users>
  <user href="/ovirt-engine/api/users/1234" id="1234">
    <name>admin</name>
    <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
    <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
    <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
    <domain_entry_id>23456</domain_entry_id>
    <namespace>*</namespace>
    <principal>user1</principal>
    <user_name>user1@domain-authz</user_name>
    <domain href="/ovirt-engine/api/domains/45678" id="45678">
      <name>domain-authz</name>
    </domain>
  </user>
</users>

Copy to Clipboard

Toggle word wrap

返されるユーザーのリストの順序は保証されません。

Expand

表6.762 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すユーザーの最大数を設定します。
`search`	String	In	返されるユーザーを制限するために使用されるクエリー文字列。
`ユーザー`	User[]	Out	ユーザーのリスト。

6.250.2.1. case_sensitive
リンクのコピー

6.250.2.2. follow
リンクのコピー

6.250.2.3. max
リンクのコピー

返すユーザーの最大数を設定します。指定しない場合、すべてのユーザーが返されます。

6.251. VirtualFunctionAllowedNetwork
リンクのコピー

Expand

表6.763 メソッドの概要
名前	Summary
`get`
`remove`

6.251.1. get GET
リンクのコピー

Expand

表6.764 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`network`	Network	Out

6.251.1.1. follow
リンクのコピー

6.251.2. remove DELETE
リンクのコピー

Expand

表6.765 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.252. VirtualFunctionAllowedNetworks
リンクのコピー

Expand

表6.766 メソッドの概要
名前	Summary
`add`
`list`	ネットワークのリストを返します。

6.252.1. add POST
リンクのコピー

Expand

表6.767 パラメーターの概要
名前	型	方向	Summary
`network`	Network	In/Out

6.252.2. list GET
リンクのコピー

ネットワークのリストを返します。

返されるネットワークリストの順序は保証されません。

Expand

表6.768 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すネットワークの最大数を設定します。
`networks`	Network[]	Out

6.252.2.1. follow
リンクのコピー

6.252.2.2. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

6.253. Vm
リンクのコピー

Expand

表6.769 メソッドの概要
名前	Summary
`autopincpuandnumanodes`	VM に自動 CPU および NUMA 設定を適用します。
`cancelmigration`	この操作は、別の物理ホストへの仮想マシンの移行を停止します。
`clone`
`commitsnapshot`	仮想マシンをプレビューされたスナップショットの状態に永続的に復元します。
`detach`	プールから仮想マシンをデタッチします。
`export`	仮想マシンをエクスポートします。
`freezefilesystems`	仮想マシンのファイルシステムをフリーズします。
`get`	仮想マシンの説明を取得します。
`logon`	外部コンソールから仮想マシンにアクセスするための自動ユーザーログオンを開始します。
`maintenance`	ホスト型エンジン仮想マシンのグローバルメンテナンスモードを設定します。
`migrate`	仮想マシンを別の物理ホストに移行します。
`previewsnapshot`	仮想マシンをスナップショットの状態に一時的に復元します。
`reboot`	仮想マシンに再起動リクエストを送信します。
`remove`	アタッチされている仮想ディスクを含む仮想マシンを削除します。
`reordermacaddresses`
`reset`	仮想マシンにリセットリクエストを送信します。
`screenshot`	VM の現在の状態のスクリーンショットをキャプチャーします。
`shutdown`	この操作は、シャットダウンリクエストを仮想マシンに送信します。
`start`	仮想マシンを起動します。
`stop`	この操作により、仮想マシンの電源が強制的にオフになります。
`suspend`	この操作により、仮想マシンの状態がディスクに保存され、停止されます。
`thawfilesystems`	仮想マシンのファイルシステムを解凍します。
`ticket`	仮想マシンのディスプレイにアクセスするための時間制約のある認証トークンを生成します。
`undosnapshot`	スナップショットをプレビューする前の状態に仮想マシンを復元します。
`update`	指定された仮想マシン ID のシステム内の仮想マシンを更新します。

6.253.1. autopincpuandnumanodes POST
リンクのコピー

VM に自動 CPU および NUMA 設定を適用します。

重要

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

リクエストの例:

POST /ovirt-engine/api/vms/123/autopincpuandnumanodes

POST /ovirt-engine/api/vms/123/autopincpuandnumanodes

Copy to Clipboard

Toggle word wrap

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

<action>
  <optimize_cpu_settings>true</optimize_cpu_settings>
</action>

<action>
  <optimize_cpu_settings>true</optimize_cpu_settings>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.770 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	デタッチアクションを非同期で実行する必要があるかどうかを示します。
`optimize_cpu_settings`	ブール値	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

POST /ovirt-engine/api/vms/123/cancelmigration

Copy to Clipboard

Toggle word wrap

cancel migration アクションは、アクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.771 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	移行を非同期的にキャンセルする必要があるかどうかを示します。

6.253.3. clone POST
リンクのコピー

Expand

表6.772 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	クローンを非同期で実行するかどうかを示します。
`discard_snapshots`	ブール値	In	スナップショットを折りたたんで仮想マシンのクローンを作成する必要がある場合は、`discard_snapshots` パラメーターを使用します。
`storage_domain`	StorageDomain	In	仮想マシンディスクのコピー先のストレージドメイン。
`vm`	Vm	In

6.253.3.1. discard_snapshots
リンクのコピー

スナップショットを折りたたんで仮想マシンのクローンを作成する必要がある場合は、discard_snapshots パラメーターを使用します。デフォルトは true です。

6.253.4. commitsnapshot POST
リンクのコピー

仮想マシンをプレビューされたスナップショットの状態に永続的に復元します。

詳細は、preview_snapshot 操作を参照してください。

Expand

表6.773 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	スナップショットを非同期でコミットする必要があるかどうかを示します。

6.253.5. detach POST
リンクのコピー

プールから仮想マシンをデタッチします。

POST /ovirt-engine/api/vms/123/detach

POST /ovirt-engine/api/vms/123/detach

Copy to Clipboard

Toggle word wrap

detach アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.774 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	デタッチアクションを非同期で実行する必要があるかどうかを示します。

6.253.6. export POST
リンクのコピー

仮想マシンをエクスポートします。

仮想マシンは、エクスポートドメインにエクスポートできます。たとえば、仮想マシン 123 をエクスポートドメイン myexport にエクスポートするには、以下を実行します。

POST /ovirt-engine/api/vms/123/export

POST /ovirt-engine/api/vms/123/export

Copy to Clipboard

Toggle word wrap

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

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <exclusive>true</exclusive>
  <discard_snapshots>true</discard_snapshots>
</action>

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <exclusive>true</exclusive>
  <discard_snapshots>true</discard_snapshots>
</action>

Copy to Clipboard

Toggle word wrap

エンジンのバージョン 4.2 以降、仮想マシンを仮想アプライアンス (OVA) としてエクスポートすることもできます。たとえば、仮想マシン 123 を、ホスト myhost のディレクトリー /home/ovirt/ に配置される myvm.ova という名前の OVA ファイルとしてエクスポートするには、次のようにします。

POST /ovirt-engine/api/vms/123/export

POST /ovirt-engine/api/vms/123/export

Copy to Clipboard

Toggle word wrap

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

<action>
  <host>
    <name>myhost</name>
  </host>
  <directory>/home/ovirt</directory>
  <filename>myvm.ova</filename>
</action>

<action>
  <host>
    <name>myhost</name>
  </host>
  <directory>/home/ovirt</directory>
  <filename>myvm.ova</filename>
</action>

Copy to Clipboard

Toggle word wrap

注記

エクスポート操作が完了したことを確認してから、エクスポートドメインで何らかの操作を試みます。

Expand

表6.775 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	エクスポートを非同期で実行する必要があるかどうかを示します。
`discard_snapshots`	ブール値	In	すべてのスナップショットを折りたたんで仮想マシンをエクスポートする必要がある場合は、`discard_snapshots` パラメーターを使用します。
`exclusive`	ブール値	In	`exclusive` パラメーターは、仮想マシンの別のコピーがすでにエクスポートドメインに存在する場合でも、エクスポートする必要がある場合に使用します (オーバーライド)。
`storage_domain`	StorageDomain	In	仮想マシンをエクスポートする (エクスポート) ストレージドメイン。

6.253.7. freezefilesystems POST
リンクのコピー

仮想マシンのファイルシステムをフリーズします。

この操作は、実行中の仮想マシンのライブスナップショットを作成するときに、QEMU ゲストエージェントを使用して仮想マシンのファイルシステムをフリーズします。通常、これはマネージャーによって自動的に行われますが、OpenStack Volume (Cinder) ディスクを使用する仮想マシンでは API を使用して手動で実行する必要があります。

以下に例を示します。

POST /ovirt-engine/api/vms/123/freezefilesystems

POST /ovirt-engine/api/vms/123/freezefilesystems

Copy to Clipboard

Toggle word wrap

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.776 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	フリーズを非同期で実行する必要があるかどうかを示します。

6.253.8. get GET
リンクのコピー

仮想マシンの説明を取得します。

Expand

表6.777 パラメーターの概要
名前	型	方向	Summary
`all_content`	ブール値	In	仮想マシンのすべての属性を応答に含める必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`next_run`	ブール値	In	返された結果が現在実行中の仮想マシンを記述しているか、それともすでに実行されているが仮想マシンが再起動された場合にのみ有効になる変更を含む仮想マシンを記述しているかを示します。
`ovf_as_ova`	ブール値	In	結果が、その VM の OVA ファイルに表示されるように OVF を公開する必要があるかどうかを示します。
`vm`	Vm	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

GET /ovirt-engine/api/vms/123?all_content=true

Copy to Clipboard

Toggle word wrap

注記

これらの属性はパフォーマンスを低下させるため、デフォルトでは含まれていません。これらの属性はめったに使用されず、データベースへの追加のクエリーを必要とします。このパラメーターは、パフォーマンスが低下するため、必要な場合にのみ使用してください。

6.253.8.2. follow
リンクのコピー

6.253.8.3. next_run
リンクのコピー

返された結果が現在実行中の仮想マシンを記述しているか、それともすでに実行されているが仮想マシンが再起動された場合にのみ有効になる変更を含む仮想マシンを記述しているかを示します。デフォルト値は false です。

パラメーターがリクエストに含まれているが値がない場合、値は true であると見なされます。以下のリクエストは、

GET /vms/{vm:id};next_run

GET /vms/{vm:id};next_run

Copy to Clipboard

Toggle word wrap

値 true を使用することと同等です。

GET /vms/{vm:id};next_run=true

GET /vms/{vm:id};next_run=true

Copy to Clipboard

Toggle word wrap

6.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=true

GET /vms/{vm:id}?all_content=true&ovf_as_ova=true

Copy to Clipboard

Toggle word wrap

6.253.9. logon POST
リンクのコピー

外部コンソールから仮想マシンにアクセスするための自動ユーザーログオンを開始します。

このアクションには、ovirt-guest-agent-gdm-plugin および ovirt-guest-agent-pam-module パッケージがインストールされ、ovirt-guest-agent サービスが仮想マシンで実行されている必要があります。

ユーザーが外部コンソールから仮想マシンにアクセスするには、仮想マシンに対する適切なユーザー権限が必要です。

以下に例を示します。

POST /ovirt-engine/api/vms/123/logon

POST /ovirt-engine/api/vms/123/logon

Copy to Clipboard

Toggle word wrap

リクエスト本文:

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.778 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	ログオンを非同期で実行する必要があるかどうかを示します。

6.253.10. maintenance POST
リンクのコピー

ホスト型エンジン仮想マシンのグローバルメンテナンスモードを設定します。

このアクションは、他の仮想マシンには影響しません。

以下に例を示します。

POST /ovirt-engine/api/vms/123/maintenance

POST /ovirt-engine/api/vms/123/maintenance

Copy to Clipboard

Toggle word wrap

<action>
  <maintenance_enabled>true<maintenance_enabled/>
</action>

<action>
  <maintenance_enabled>true<maintenance_enabled/>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.779 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	グローバルメンテナンスアクションを非同期で実行する必要があるかどうかを示します。
`maintenance_enabled`	ブール値	In	グローバルメンテナンスを有効にするか無効にするかを示します。

6.253.11. migrate POST
リンクのコピー

仮想マシンを別の物理ホストに移行します。

以下に例を示します。

POST /ovirt-engine/api/vms/123/migrate

POST /ovirt-engine/api/vms/123/migrate

Copy to Clipboard

Toggle word wrap

仮想マシンの移行先のホストを指定するには、以下を実行します。

<action>
  <host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</action>

<action>
  <host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.780 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	移行を非同期的に実行するかどうかを指定します。
`cluster`	クラスター	In	仮想マシンの移行先のクラスターを指定します。
`force`	ブール値	In	仮想マシンが移行不可として定義されている場合でも、仮想マシンを移行する必要があることを指定します。
`host`	ホスト	In	仮想マシンの移行先となる特定のホストを指定します。
`migrate_vms_in_affinity_closure`	ブール値	In	同じホスト上で実行されている、この仮想マシンとのポジティブな適用アフィニティーグループ内の他のすべての仮想マシンも移行します。

6.253.11.1. cluster
リンクのコピー

仮想マシンの移行先のクラスターを指定します。これはオプションのパラメーターです。デフォルトでは、仮想マシンは同じクラスター内の別のホストに移行されます。

警告

別のクラスターへのライブマイグレーションはサポートされていません。移行を試みる前に、ターゲットクラスターのハードウェアアーキテクチャーとネットワークアーキテクチャーを十分に検討してください。

6.253.11.2. force
リンクのコピー

仮想マシンが移行不可として定義されている場合でも、仮想マシンを移行する必要があることを指定します。これはオプションのパラメーターです。デフォルトでは false に設定されます。

6.253.11.3. host
リンクのコピー

仮想マシンの移行先となる特定のホストを指定します。これはオプションのパラメーターです。デフォルトでは、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 メソッドを使用して破棄できます。

Expand

表6.781 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	プレビューを非同期で実行する必要があるかどうかを示します。
`disks`	Disk[]	In	スナップショットのプレビューに含まれるディスクを指定します。
`lease`	StorageDomainLease	In	スナップショットのプレビューで使用するリースストレージドメイン ID を指定します。
`restore_memory`	ブール値	In
`snapshot`	スナップショット	In
`vm`	Vm	In

6.253.12.1. disks
リンクのコピー

スナップショットのプレビューに含まれるディスクを指定します。

ディスクパラメーターごとに、その image_id も指定する必要があります。

たとえば、識別子が 111 で、その image_id が 222 のディスクを含む識別子 456 のスナップショットをプレビューするには、次のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/previewsnapshot

POST /ovirt-engine/api/vms/123/previewsnapshot

Copy to Clipboard

Toggle word wrap

リクエスト本文:

<action>
  <disks>
    <disk id="111">
      <image_id>222</image_id>
    </disk>
  </disks>
  <snapshot id="456"/>
</action>

<action>
  <disks>
    <disk id="111">
      <image_id>222</image_id>
    </disk>
  </disks>
  <snapshot id="456"/>
</action>

Copy to Clipboard

Toggle word wrap

6.253.12.2. lease
リンクのコピー

スナップショットのプレビューで使用するリースストレージドメイン ID を指定します。リースパラメーターが渡されない場合、プレビューされたスナップショットリースストレージドメインが使用されます。ストレージドメインパラメーターが空のリースパラメーターが渡された場合、スナップショットプレビューにリースは使用されません。リースパラメーターがストレージドメインパラメーターと共に渡された場合、仮想マシンスナップショットの 1 つに属するリースドメイン ID の 1 つだけをストレージドメイン ID にすることができます。これはオプションのパラメーターで、デフォルトは null に設定されています

6.253.13. reboot POST
リンクのコピー

仮想マシンに再起動リクエストを送信します。

以下に例を示します。

POST /ovirt-engine/api/vms/123/reboot

POST /ovirt-engine/api/vms/123/reboot

Copy to Clipboard

Toggle word wrap

reboot アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

バックアップが実行されている場合でも仮想マシンを再起動するには、アクションに 'force' 要素を含める必要があります。

たとえば、仮想マシン 123 を強制的に再起動するには、以下を実行します。

POST /ovirt-engine/api/vms/123/reboot

POST /ovirt-engine/api/vms/123/reboot

Copy to Clipboard

Toggle word wrap

<action>
    <force>true</force>
</action>

<action>
    <force>true</force>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.782 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	再起動を非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In	仮想マシンのバックアップが実行されている場合でも、仮想マシンを強制的に再起動する必要があるかどうかを示します。

6.253.14. remove DELETE
リンクのコピー

アタッチされている仮想ディスクを含む仮想マシンを削除します。

たとえば、識別子が 123 の仮想マシンを削除するには、以下を実行します。

DELETE /ovirt-engine/api/vms/123

DELETE /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

Expand

表6.783 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。
`detach_only`	ブール値	In	アタッチされた仮想ディスクを削除する代わりに、最初にデタッチして保持する必要があるかどうかを示しています。
`force`	ブール値	In	仮想マシンを強制的に削除する必要があるかどうかを示します。

6.253.14.1. force
リンクのコピー

仮想マシンを強制的に削除する必要があるかどうかを示します。

ロックされた仮想マシンおよびロックされたディスクイメージを持つ仮想マシンは、このフラグを true に設定しないと削除できません。

6.253.15. reordermacaddresses POST
リンクのコピー

Expand

表6.784 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクションを非同期で実行する必要があるかどうかを示します。

6.253.16. reset POST
リンクのコピー

仮想マシンにリセットリクエストを送信します。

以下に例を示します。

POST /ovirt-engine/api/vms/123/reset

POST /ovirt-engine/api/vms/123/reset

Copy to Clipboard

Toggle word wrap

reset アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.785 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	リセットを非同期で実行する必要があるかどうかを示します。

6.253.17. screenshot POST
リンクのコピー

VM の現在の状態のスクリーンショットをキャプチャーします。

以下に例を示します。

POST /ovirt-engine/api/vms/123/screenshot

POST /ovirt-engine/api/vms/123/screenshot

Copy to Clipboard

Toggle word wrap

screenshot アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

6.253.18. shutdown POST
リンクのコピー

この操作は、シャットダウンリクエストを仮想マシンに送信します。

以下に例を示します。

POST /ovirt-engine/api/vms/123/shutdown

POST /ovirt-engine/api/vms/123/shutdown

Copy to Clipboard

Toggle word wrap

shutdown アクションはアクション固有のパラメーターを取らないので、リクエスト本文は空の action を含む必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

バックアップが実行されている場合でも仮想マシンをシャットダウンするには、アクションに 'force' 要素を含める必要があります。

たとえば、仮想マシン 123 を強制的にシャットダウンするには、以下を実行します。

POST /ovirt-engine/api/vms/123/shutdown

POST /ovirt-engine/api/vms/123/shutdown

Copy to Clipboard

Toggle word wrap

<action>
    <force>true</force>
</action>

<action>
    <force>true</force>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.786 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	シャットダウンを非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In	バックアップが実行されている場合でも、仮想マシンを強制的にシャットダウンする必要があるかどうかを示します。
`reason`	String	In	仮想マシンが停止した理由。

6.253.18.1. reason
リンクのコピー

仮想マシンが停止した理由。オプションで、仮想マシンをシャットダウンするときにユーザーが設定します。

6.253.19. start POST
リンクのコピー

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

仮想環境が完成し、機能するために必要なすべてのコンポーネントが仮想マシンに含まれている場合は、仮想マシンを起動できます。

この例では、仮想マシンを起動します。

POST /ovirt-engine/api/vms/123/start

POST /ovirt-engine/api/vms/123/start

Copy to Clipboard

Toggle word wrap

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

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.787 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	起動アクションを非同期で実行する必要があるかどうかを示します。
`authorized_key`	AuthorizedKey	In
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`pause`	ブール値	In	`true` に設定されている場合、仮想マシンを一時停止モードで起動します。
`use_cloud_init`	ブール値	In	`true` に設定すると、初期化タイプは cloud-init に設定されます。
`use_ignition`	ブール値	In	`true` に設定すると、初期化タイプは Ignition に設定されます。
`use_initialization`	ブール値	In	`true` に設定すると、初期化タイプは VM の OS によって設定されます。
`use_sysprep`	ブール値	In	`true` に設定すると、初期化タイプは Sysprep に設定されます。
`vm`	Vm	In	この特定の実行のための仮想マシンの定義。
`volatile`	ブール値	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>

<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>

Copy to Clipboard

Toggle word wrap

これにより、この特定の起動に対してのみブートデバイスが CDROM に設定されます。仮想マシンの電源がオフになると、この定義は元に戻ります。

6.253.19.7. volatile
リンクのコピー

ゲストが開始した再起動の場合でも、この実行設定が破棄されることを示します。デフォルト値は false です。

6.253.20. stop POST
リンクのコピー

この操作により、仮想マシンの電源が強制的にオフになります。

以下に例を示します。

POST /ovirt-engine/api/vms/123/stop

POST /ovirt-engine/api/vms/123/stop

Copy to Clipboard

Toggle word wrap

stop アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文は空の action を含む必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

バックアップが実行されている場合でも仮想マシンを停止するには、アクションに 'force' 要素を含める必要があります。

たとえば、仮想マシン 123 を強制的に停止するには、以下を実行します。

POST /ovirt-engine/api/vms/123/stop

POST /ovirt-engine/api/vms/123/stop

Copy to Clipboard

Toggle word wrap

<action>
    <force>true</force>
</action>

<action>
    <force>true</force>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.788 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	stop アクションを非同期で実行する必要があるかどうかを示します。
`force`	ブール値	In	バックアップが実行されている場合でも、仮想マシンを強制的に停止する必要があるかどうかを示します。
`reason`	String	In	仮想マシンが停止した理由。

6.253.20.1. reason
リンクのコピー

仮想マシンが停止した理由。オプションで、仮想マシンをシャットダウンするときにユーザーが設定します。

6.253.21. suspend POST
リンクのコピー

この操作により、仮想マシンの状態がディスクに保存され、停止されます。停止された仮想マシンを起動し、起動アクションで仮想マシンの状態を復元します。

以下に例を示します。

POST /ovirt-engine/api/vms/123/suspend

POST /ovirt-engine/api/vms/123/suspend

Copy to Clipboard

Toggle word wrap

suspend アクションはアクション固有のパラメーターを取らないので、リクエスト本文は空の action を含む必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.789 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	suspend アクションを非同期で実行する必要があるかどうかを示します。

6.253.22. thawfilesystems POST
リンクのコピー

仮想マシンのファイルシステムを解凍します。

この操作は、実行中の仮想マシンのライブスナップショットを作成するときに、QEMU ゲストエージェントを使用して仮想マシンのファイルシステムを解凍します。通常、これはマネージャーによって自動的に行われますが、OpenStack Volume (Cinder) ディスクを使用する仮想マシンでは API を使用して手動で実行する必要があります。

以下に例を示します。

POST /api/vms/123/thawfilesystems

POST /api/vms/123/thawfilesystems

Copy to Clipboard

Toggle word wrap

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.790 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	ファイルシステムの解凍アクションを非同期で実行する必要があるかどうかを示します。

6.253.23. ticket POST
リンクのコピー

仮想マシンのディスプレイにアクセスするための時間制約のある認証トークンを生成します。

以下に例を示します。

POST /ovirt-engine/api/vms/123/ticket

POST /ovirt-engine/api/vms/123/ticket

Copy to Clipboard

Toggle word wrap

クライアント指定のアクションには、必要に応じて、必要なチケット値および/または有効期限 (秒単位) が含まれます。

応答は、使用された実際のチケットの値と有効期限を指定します。

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>

Copy to Clipboard

Toggle word wrap

重要

仮想マシンが 1 つのグラフィックスプロトコルのみをサポートするように設定されている場合、生成された認証トークンはそのプロトコルに対して有効になります。ただし、仮想マシンが複数のプロトコル (VNC と SPICE) をサポートするように設定されている場合、認証トークンは SPICE プロトコルに対してのみ有効になります。

VNC など特定のプロトコルの認証トークンを取得するには、仮想マシンのグラフィックスコンソールを管理するサービスの ticket メソッドを使用して、リクエストを送信します。

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket

Copy to Clipboard

Toggle word wrap

Expand

表6.791 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	チケットの生成を非同期で実行する必要があるかどうかを示します。
`ticket`	Ticket	In/Out

6.253.24. undosnapshot POST
リンクのコピー

スナップショットをプレビューする前の状態に仮想マシンを復元します。

詳細は、preview_snapshot 操作を参照してください。

Expand

表6.792 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	スナップショットをもとに戻すアクションを非同期で実行する必要があるかどうかを示します。

6.253.25. update PUT
リンクのコピー

指定された仮想マシン ID のシステム内の仮想マシンを更新します。

Expand

表6.793 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`next_run`	ブール値	In	更新を仮想マシンにすぐに適用するか、仮想マシンの再起動時にのみ適用するかを示します。
`vm`	Vm	In/Out

6.253.25.1. next_run
リンクのコピー

更新を仮想マシンにすぐに適用するか、仮想マシンの再起動時にのみ適用するかを示します。デフォルト値は false で、デフォルトでは変更が即座に適用されます。

6.254. VmApplication
リンクのコピー

仮想マシンにインストールされたアプリケーションに関する情報を提供するサービス。

Expand

表6.794 メソッドの概要
名前	Summary
`get`	アプリケーションに関する情報を返します。

6.254.1. get GET
リンクのコピー

アプリケーションに関する情報を返します。

Expand

表6.795 パラメーターの概要
名前	型	方向	Summary
`application`	アプリケーション	Out	アプリケーションに関する情報。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.254.1.1. application
リンクのコピー

アプリケーションに関する情報。

この情報には、アプリケーションの名前を含む name 属性 (バージョンなどの追加情報を含む場合がある任意の文字列) と、仮想マシンを識別する vm 属性でが含まれます。

たとえば、以下のようなリクエストです。

GET /ovirt-engine/api/vms/123/applications/789

GET /ovirt-engine/api/vms/123/applications/789

Copy to Clipboard

Toggle word wrap

次のような情報が返される場合があります。

<application href="/ovirt-engine/api/vms/123/applications/789" id="789">
  <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>

<application href="/ovirt-engine/api/vms/123/applications/789" id="789">
  <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>

Copy to Clipboard

Toggle word wrap

6.254.1.2. follow
リンクのコピー

6.255. VmApplications
リンクのコピー

仮想マシンにインストールされているアプリケーションに関する情報を提供するサービス。

Expand

表6.796 メソッドの概要
名前	Summary
`list`	仮想マシンにインストールされているアプリケーションのリストを返します。

6.255.1. list GET
リンクのコピー

仮想マシンにインストールされているアプリケーションのリストを返します。

返されるアプリケーションリストの順序は保証されません。

Expand

表6.797 パラメーターの概要
名前	型	方向	Summary
`applications`	Application[]	Out	仮想マシンにインストールされているアプリケーションのリスト。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すアプリケーションの最大数を設定します。

6.255.1.1. applications
リンクのコピー

仮想マシンにインストールされているアプリケーションのリスト。

たとえば、以下のようなリクエストです。

GET /ovirt-engine/api/vms/123/applications/

GET /ovirt-engine/api/vms/123/applications/

Copy to Clipboard

Toggle word wrap

次のようなリストが返される場合があります。

<applications>
  <application href="/ovirt-engine/api/vms/123/applications/456" id="456">
    <name>kernel-3.10.0-327.36.1.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
  <application href="/ovirt-engine/api/vms/123/applications/789" id="789">
    <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
</applications>

<applications>
  <application href="/ovirt-engine/api/vms/123/applications/456" id="456">
    <name>kernel-3.10.0-327.36.1.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
  <application href="/ovirt-engine/api/vms/123/applications/789" id="789">
    <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
</applications>

Copy to Clipboard

Toggle word wrap

6.255.1.2. follow
リンクのコピー

6.255.1.3. max
リンクのコピー

返すアプリケーションの最大数を設定します。指定されていない場合は、すべてのアプリケーションが返されます。

6.256. VmBackup
リンクのコピー

仮想マシンのバックアップを管理するサービス。

Expand

表6.798 メソッドの概要
名前	Summary
`finalize`	仮想マシンのバックアップエンティティーの最終処理を行います。
`get`	仮想マシンのバックアップに関する情報を返します。

6.256.1. finalize POST
リンクのコピー

仮想マシンのバックアップエンティティーの最終処理を行います。

バックアップを終了し、リソースのロックを解除し、クリーンアップを実行します。ID が '123' の仮想マシンと ID が '456' のバックアップをファイナライズするには、次のように要求を送信します。

POST /ovirt-engine/api/vms/123/backups/456/finalize

POST /ovirt-engine/api/vms/123/backups/456/finalize

Copy to Clipboard

Toggle word wrap

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

<action />

<action />

Copy to Clipboard

Toggle word wrap

6.256.2. get GET
リンクのコピー

仮想マシンのバックアップに関する情報を返します。

Expand

表6.799 パラメーターの概要
名前	型	方向	Summary
`backup`	バックアップ	Out	仮想マシンのバックアップエンティティーに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.256.2.1. backup
リンクのコピー

仮想マシンのバックアップエンティティーに関する情報。

<backups>
  <backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <link href="/ovirt-engine/api/vms/vm-uuid/backups/backup-uuid/disks" rel="disks"/>
    <status>initializing</status>
    <creation_date>
 </backup>
</backups>

<backups>
  <backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <link href="/ovirt-engine/api/vms/vm-uuid/backups/backup-uuid/disks" rel="disks"/>
    <status>initializing</status>
    <creation_date>
 </backup>
</backups>

Copy to Clipboard

Toggle word wrap

6.256.2.2. follow
リンクのコピー

6.257. VmBackupDisk
リンクのコピー

Expand

表6.800 メソッドの概要
名前	Summary
`get`	ディスクの説明を取得します。

6.257.1. get GET
リンクのコピー

ディスクの説明を取得します。

Expand

表6.801 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	Out	ディスクの説明。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.257.1.1. follow
リンクのコピー

6.258. VmBackupDisks
リンクのコピー

Expand

表6.802 メソッドの概要
名前	Summary
`list`	バックアップ内のディスクのリストを返します。

6.258.1. list GET
リンクのコピー

バックアップ内のディスクのリストを返します。

Expand

表6.803 パラメーターの概要
名前	型	方向	Summary
`disks`	Disk[]	Out	取得されたディスクのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。

6.258.1.1. follow
リンクのコピー

6.258.1.2. max
リンクのコピー

返すディスクの最大数を設定します。指定されていない場合は、すべてのディスクが返されます。

6.259. VmBackups
リンクのコピー

仮想マシンのバックアップをリスト表示します。

Expand

表6.804 メソッドの概要
名前	Summary
`add`	新しいバックアップエンティティーを仮想マシンに追加します。
`list`	仮想マシンのバックアップのリスト。

6.259.1. add POST
リンクのコピー

新しいバックアップエンティティーを仮想マシンに追加します。

たとえば、チェックポイント ID previous-checkpoint-uuid から仮想マシンの新しい増分バックアップを開始するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/backups

POST /ovirt-engine/api/vms/123/backups

Copy to Clipboard

Toggle word wrap

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

<backup>
  <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
  <disks>
      <disk id="disk-uuid" />
      ...
  </disks>
</backup>

<backup>
  <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
  <disks>
      <disk id="disk-uuid" />
      ...
  </disks>
</backup>

Copy to Clipboard

Toggle word wrap

応答本文:

<backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <to_checkpoint_id>new-checkpoint-uuid</to_checkpoint_id>
    <disks>
        <disk id="disk-uuid" />
        ...
        ...
    </disks>
    <status>initializing</status>
    <creation_date>
</backup>

<backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <to_checkpoint_id>new-checkpoint-uuid</to_checkpoint_id>
    <disks>
        <disk id="disk-uuid" />
        ...
        ...
    </disks>
    <status>initializing</status>
    <creation_date>
</backup>

Copy to Clipboard

Toggle word wrap

作成されたバックアップの ID を提供するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/backups

POST /ovirt-engine/api/vms/123/backups

Copy to Clipboard

Toggle word wrap

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

<backup id="backup-uuid">
  <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
  <disks>
      <disk id="disk-uuid" />
      ...
  </disks>
</backup>

<backup id="backup-uuid">
  <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
  <disks>
      <disk id="disk-uuid" />
      ...
  </disks>
</backup>

Copy to Clipboard

Toggle word wrap

Expand

表6.805 パラメーターの概要
名前	型	方向	Summary
`backup`	バックアップ	In/Out	仮想マシンのバックアップエンティティーに関する情報。
`require_consistency`	ブール値	In	VM がフリーズに失敗した場合にバックアップが失敗するかどうかを示します。
`use_active`	ブール値	In	バックアップの実行にアクティブボリュームを使用するかどうかを示します。

6.259.1.1. require_consistency
リンクのコピー

VM がフリーズに失敗した場合にバックアップが失敗するかどうかを示します。

requireConsistency=True の場合に、VM のフリーズに失敗した場合は VM のバックアップは失敗します。

REST API 呼び出しは次のようになります。

POST /ovirt-engine/api/vms/123/backups?require_consistency=true

POST /ovirt-engine/api/vms/123/backups?require_consistency=true

Copy to Clipboard

Toggle word wrap

requireConsistency フラグのデフォルト値は false です。

6.259.1.2. use_active
リンクのコピー

バックアップの実行にアクティブボリュームを使用するかどうかを示します。

useActive=False の場合、バックアップ操作用のスナップショットが作成されます。

REST API 呼び出しは次のようになります。

POST /ovirt-engine/api/vms/123/backups?use_active=false

POST /ovirt-engine/api/vms/123/backups?use_active=false

Copy to Clipboard

Toggle word wrap

useActive フラグのデフォルト値は false です。

6.259.2. list GET
リンクのコピー

仮想マシンのバックアップのリスト。

Expand

表6.806 パラメーターの概要
名前	型	方向	Summary
`backups`	Backup[]	Out	仮想マシンのバックアップエンティティーに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す仮想マシンバックアップの最大数を設定します。

6.259.2.1. backups
リンクのコピー

仮想マシンのバックアップエンティティーに関する情報。

<backups>
  <backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <disks>
      <disk id="disk-uuid" />
      ...
      ...
    </disks>
    <status>initiailizing</status>
    <creation_date>
 </backup>
</backups>

<backups>
  <backup id="backup-uuid">
    <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
    <disks>
      <disk id="disk-uuid" />
      ...
      ...
    </disks>
    <status>initiailizing</status>
    <creation_date>
 </backup>
</backups>

Copy to Clipboard

Toggle word wrap

6.259.2.2. follow
リンクのコピー

6.259.2.3. max
リンクのコピー

返す仮想マシンバックアップの最大数を設定します。指定されていない場合は、すべての仮想マシンのバックアップが返されます。

6.260. VmCdrom
リンクのコピー

仮想マシンの CDROM デバイスを管理します。

ディスクの変更と取り出しは、file 属性の値を変更するために、常に update メソッドを使用して行われます。

Expand

表6.807 メソッドの概要
名前	Summary
`get`	この CDROM デバイスに関する情報を返します。
`update`	この CDROM デバイスに関する情報を更新します。

6.260.1. get GET
リンクのコピー

この CDROM デバイスに関する情報を返します。

この情報は、CDROM デバイス、仮想マシン、およびオプションで挿入されたディスクへの参照を含む cdrom 属性で構成されます。

ディスクが挿入されている場合は、file 属性には ISO イメージへの参照が含まれます。

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <file id="mycd.iso"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <file id="mycd.iso"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>

Copy to Clipboard

Toggle word wrap

ディスクが挿入されていない場合は、file 属性は報告されません。

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>

Copy to Clipboard

Toggle word wrap

Expand

表6.808 パラメーターの概要
名前	型	方向	Summary
`cdrom`	Cdrom	Out	CDROM デバイスに関する情報。
`current`	ブール値	In	操作が現在実行中の仮想マシンの情報を返す必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.260.1.1. current
リンクのコピー

操作が現在実行中の仮想マシンの情報を返す必要があるかどうかを示します。このパラメーターはオプションであり、デフォルト値は false です。

6.260.1.2. follow
リンクのコピー

6.260.2. update PUT
リンクのコピー

この CDROM デバイスに関する情報を更新します。

file 属性の値を変更することにより、ディスクを変更またはイジェクトすることができます。たとえば、ディスクを挿入または変更するには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000

Copy to Clipboard

Toggle word wrap

本文には、file 属性の新しい値が含まれている必要があります。

<cdrom>
  <file id="mycd.iso"/>
</cdrom>

<cdrom>
  <file id="mycd.iso"/>
</cdrom>

Copy to Clipboard

Toggle word wrap

id 属性の値 (この例では mycd.iso) は、アタッチされた ISO ストレージドメインで使用可能なファイルに対応している必要があります。

ディスクのイジェクトには、空の id を持つ file を使用します。

<cdrom>
  <file id=""/>
</cdrom>

<cdrom>
  <file id=""/>
</cdrom>

Copy to Clipboard

Toggle word wrap

デフォルトでは、上記の操作は次回の起動後に仮想マシンに表示されるディスクを永続的に変更しますが、現在実行中の仮想マシンには影響しません。現在実行中の仮想マシンに表示されるディスクを変更する場合は、current=true パラメーターを追加します。たとえば、現在のディスクを取り出すには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true

Copy to Clipboard

Toggle word wrap

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

<cdrom>
  <file id=""/>
</cdrom>

<cdrom>
  <file id=""/>
</cdrom>

Copy to Clipboard

Toggle word wrap

重要

current=true パラメーターで行われた変更は永続化されないため、仮想マシンの再起動後は効果がありません。

Expand

表6.809 パラメーターの概要
名前	型	方向	Summary
`cdrom`	Cdrom	In/Out	CDROM デバイスに関する情報。
`current`	ブール値	In	現在実行中の仮想マシンに更新を適用するか、次回の起動後の仮想マシンに適用するかを指定します。

6.260.2.1. current
リンクのコピー

現在実行中の仮想マシンに更新を適用するか、次回の起動後の仮想マシンに適用するかを指定します。このパラメーターはオプションであり、デフォルト値は false です。これは、デフォルトでは次回の起動後にのみ更新が有効になることを意味します。

6.261. VmCdroms
リンクのコピー

仮想マシンの CDROM デバイスを管理します。

現在、仮想マシンには CDROM デバイスが 1 つだけあります。新しいデバイスを追加することはできず、既存のデバイスを削除することもできないため、add または remove のメソッドはありません。CDROM ディスクの変更と取り出しは、CDROM デバイスを管理する service の update メソッドで行います。

Expand

表6.810 メソッドの概要
名前	Summary
`add`	指定された ID で識別される仮想マシンに cdrom を追加します。
`list`	仮想マシンの CDROM デバイスのリストを返します。

6.261.1. add POST
リンクのコピー

指定された ID で識別される仮想マシンに cdrom を追加します。

Expand

表6.811 パラメーターの概要
名前	型	方向	Summary
`cdrom`	Cdrom	In/Out

6.261.2. list GET
リンクのコピー

仮想マシンの CDROM デバイスのリストを返します。

返される CD-ROM デバイスリストの順序は保証されません。

Expand

表6.812 パラメーターの概要
名前	型	方向	Summary
`cdroms`	Cdrom[]	Out	仮想マシンの CDROM デバイスのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す CDROM の最大数を設定します。

6.261.2.1. follow
リンクのコピー

6.261.2.2. max
リンクのコピー

返す CDROM の最大数を設定します。指定されていない場合は、すべての CDROM が返されます。

6.262. VmCheckpoint
リンクのコピー

仮想マシンのチェックポイントを管理するサービス。

Expand

表6.813 メソッドの概要
名前	Summary
`get`	仮想マシンのチェックポイントに関する情報を返します。
`remove`	仮想マシンのチェックポイントエンティティーを削除します。

6.262.1. get GET
リンクのコピー

仮想マシンのチェックポイントに関する情報を返します。

Expand

表6.814 パラメーターの概要
名前	型	方向	Summary
`checkpoint`	Checkpoint	Out	仮想マシンのチェックポイントエンティティーに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.262.1.1. checkpoint
リンクのコピー

仮想マシンのチェックポイントエンティティーに関する情報。

<checkpoint id="checkpoint-uuid">
 <link href="/ovirt-engine/api/vms/vm-uuid/checkpoints/checkpoint-uuid/disks" rel="disks"/>
 <parent_id>parent-checkpoint-uuid</parent_id>
 <creation_date>xxx</creation_date>
 <vm href="/ovirt-engine/api/vms/vm-uuid" id="vm-uuid"/>
</checkpoint>

<checkpoint id="checkpoint-uuid">
 <link href="/ovirt-engine/api/vms/vm-uuid/checkpoints/checkpoint-uuid/disks" rel="disks"/>
 <parent_id>parent-checkpoint-uuid</parent_id>
 <creation_date>xxx</creation_date>
 <vm href="/ovirt-engine/api/vms/vm-uuid" id="vm-uuid"/>
</checkpoint>

Copy to Clipboard

Toggle word wrap

6.262.1.2. follow
リンクのコピー

6.262.2. remove DELETE
リンクのコピー

仮想マシンのチェックポイントエンティティーを削除します。

libvirt とデータベースからチェックポイントを削除します。

Expand

表6.815 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.263. VmCheckpointDisk
リンクのコピー

Expand

表6.816 メソッドの概要
名前	Summary
`get`	ディスクの説明を取得します。

6.263.1. get GET
リンクのコピー

ディスクの説明を取得します。

Expand

表6.817 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	Out	ディスクの説明。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.263.1.1. follow
リンクのコピー

6.264. VmCheckpointDisks
リンクのコピー

Expand

表6.818 メソッドの概要
名前	Summary
`list`	チェックポイント内のディスクのリストを返します。

6.264.1. list GET
リンクのコピー

チェックポイント内のディスクのリストを返します。

Expand

表6.819 パラメーターの概要
名前	型	方向	Summary
`disks`	Disk[]	Out	取得されたディスクのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。

6.264.1.1. follow
リンクのコピー

6.264.1.2. max
リンクのコピー

返すディスクの最大数を設定します。指定されていない場合は、すべてのディスクが返されます。

6.265. VmCheckpoints
リンクのコピー

仮想マシンのチェックポイントをリスト表示します。

Expand

表6.820 メソッドの概要
名前	Summary
`list`	仮想マシンチェックポイントのリスト。

6.265.1. list GET
リンクのコピー

仮想マシンチェックポイントのリスト。

ID が '123' の仮想マシンのチェックポイントのリストを取得するには、次のようにリクエストを送信します。

GET /ovirt-engine/api/vms/123/checkpoints

GET /ovirt-engine/api/vms/123/checkpoints

Copy to Clipboard

Toggle word wrap

Expand

表6.821 パラメーターの概要
名前	型	方向	Summary
`checkpoints`	Checkpoint[]	Out	仮想マシンのチェックポイントエンティティーに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す仮想マシンチェックポイントの最大数を設定します。

6.265.1.1. checkpoints
リンクのコピー

仮想マシンのチェックポイントエンティティーに関する情報。

<checkpoints>
  <checkpoint id="checkpoint-uuid">
    <link href="/ovirt-engine/api/vms/vm-uuid/checkpoints/checkpoint-uuid/disks" rel="disks"/>
    <parent_id>parent-checkpoint-uuid</parent_id>
    <creation_date>xxx</creation_date>
    <vm href="/ovirt-engine/api/vm-uuid" id="vm-uuid"/>
 </checkpoint>
</checkpoints>

<checkpoints>
  <checkpoint id="checkpoint-uuid">
    <link href="/ovirt-engine/api/vms/vm-uuid/checkpoints/checkpoint-uuid/disks" rel="disks"/>
    <parent_id>parent-checkpoint-uuid</parent_id>
    <creation_date>xxx</creation_date>
    <vm href="/ovirt-engine/api/vm-uuid" id="vm-uuid"/>
 </checkpoint>
</checkpoints>

Copy to Clipboard

Toggle word wrap

6.265.1.2. follow
リンクのコピー

6.265.1.3. max
リンクのコピー

返す仮想マシンチェックポイントの最大数を設定します。指定されていない場合は、すべての仮想マシンのチェックポイントが返されます。

6.266. VmDisk
リンクのコピー

Expand

表6.822 メソッドの概要
名前	Summary
`activate`
`deactivate`
`export`
`get`
`move`
`reduce`	ディスクイメージのサイズを縮小します。
`remove`	仮想マシンからディスクを切り離します。
`update`

6.266.1. activate POST
リンクのコピー

Expand

表6.823 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクティベーションを非同期で実行する必要があるかどうかを示します。

6.266.2. deactivate POST
リンクのコピー

Expand

表6.824 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	非アクティブ化を非同期で実行する必要があるかどうかを示します。

6.266.3. export POST
リンクのコピー

Expand

表6.825 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	エクスポートを非同期で実行する必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。

6.266.4. get GET
リンクのコピー

Expand

表6.826 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.266.4.1. follow
リンクのコピー

6.266.5. move POST
リンクのコピー

Expand

表6.827 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	移動を非同期で実行する必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。

6.266.6. reduce POST
リンクのコピー

ディスクイメージのサイズを縮小します。

Expand

表6.828 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.266.7. remove DELETE
リンクのコピー

仮想マシンからディスクを切り離します。

注記

API のバージョン 3 では、これによりディスクがシステムから完全に削除されていましたが、バージョン 4 以降では削除されません。完全に削除する必要がある場合は、最上位のディスクサービスの remove メソッドを使用します。

Expand

表6.829 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.266.8. update PUT
リンクのコピー

Expand

表6.830 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`disk`	ディスク	In/Out

6.267. VmDisks
リンクのコピー

Expand

表6.831 メソッドの概要
名前	Summary
`add`
`list`	仮想マシンのディスクのリストを返します。

6.267.1. add POST
リンクのコピー

Expand

表6.832 パラメーターの概要
名前	型	方向	Summary
`disk`	ディスク	In/Out

6.267.2. list GET
リンクのコピー

仮想マシンのディスクのリストを返します。

返されるフックリストの順序は保証されません。

Expand

表6.833 パラメーターの概要
名前	型	方向	Summary
`disks`	Disk[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すディスクの最大数を設定します。

6.267.2.1. follow
リンクのコピー

6.267.2.2. max
リンクのコピー

返すディスクの最大数を設定します。指定しない場合、すべてのディスクが返されます。

6.268. VmGraphicsConsole
リンクのコピー

Expand

表6.834 メソッドの概要
名前	Summary
`get`	仮想マシンのグラフィックコンソール設定を取得します。
`proxyticket`
`remoteviewerconnectionfile`	`remote-viewer` クライアントと互換性のあるファイルを生成します。
`remove`	仮想マシンからグラフィックコンソールを削除します。
`ticket`	この仮想マシンのコンソールにアクセスするための時間制約のある認証トークンを生成します。

6.268.1. get GET
リンクのコピー

仮想マシンのグラフィックコンソール設定を取得します。

重要

デフォルトでは、current パラメーターが指定されていない場合、返されるデータは仮想マシンの次の実行に対応します。システムの現在の実装では、これは、システムが次の実行に使用されるアドレスとポートを認識していないため、address と port の属性が入力されないことを意味します。ほとんどの場合、これらの属性が必要であるため、current パラメーターを値 true で常に明示的に含めることを強く推奨します。

Expand

表6.835 パラメーターの概要
名前	型	方向	Summary
`console`	GraphicsConsole	Out	仮想マシンのグラフィックコンソールに関する情報。
`current`	ブール値	In	返されるデータが仮想マシンの次の実行に対応するか、現在の実行に対応するかを指定します。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.268.1.1. current
リンクのコピー

返されるデータが仮想マシンの次の実行に対応するか、現在の実行に対応するかを指定します。

重要

値が true でない限り、address と port の属性は入力されません。

たとえば、address と port の属性など、仮想マシンの現在の実行に関するデータを取得するには、次のようなリクエストを送信します。

GET /ovit-engine/api/vms/123/graphicsconsoles/456?current=true

GET /ovit-engine/api/vms/123/graphicsconsoles/456?current=true

Copy to Clipboard

Toggle word wrap

デフォルト値は false です。

6.268.1.2. follow
リンクのコピー

6.268.2. proxyticket POST
リンクのコピー

Expand

表6.836 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	チケットの生成を非同期で実行する必要があるかどうかを示します。
`proxy_ticket`	ProxyTicket	Out

6.268.3. remoteviewerconnectionfile POST
リンクのコピー

remote-viewer クライアントと互換性のあるファイルを生成します。

次のリクエストを使用して、グラフィックコンソールのリモートビューアー接続ファイルを生成します。このアクションは、仮想マシンが実行されている場合にのみファイルを生成することに注意してください。

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/remoteviewerconnectionfile

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/remoteviewerconnectionfile

Copy to Clipboard

Toggle word wrap

remoteviewerconnectionfile アクションはアクション固有のパラメーターを取らないので、リクエスト本文は空の action を含む必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

応答には、remote-viewer クライアントで使用できるファイルが含まれています。

<action>
  <remote_viewer_connection_file>
    [virt-viewer]
    type=spice
    host=192.168.1.101
    port=-1
    password=123456789
    delete-this-file=1
    fullscreen=0
    toggle-fullscreen=shift+f11
    release-cursor=shift+f12
    secure-attention=ctrl+alt+end
    tls-port=5900
    enable-smartcard=0
    enable-usb-autoshare=0
    usb-filter=null
    tls-ciphers=DEFAULT
    host-subject=O=local,CN=example.com
    ca=...
  </remote_viewer_connection_file>
</action>

<action>
  <remote_viewer_connection_file>
    [virt-viewer]
    type=spice
    host=192.168.1.101
    port=-1
    password=123456789
    delete-this-file=1
    fullscreen=0
    toggle-fullscreen=shift+f11
    release-cursor=shift+f12
    secure-attention=ctrl+alt+end
    tls-port=5900
    enable-smartcard=0
    enable-usb-autoshare=0
    usb-filter=null
    tls-ciphers=DEFAULT
    host-subject=O=local,CN=example.com
    ca=...
  </remote_viewer_connection_file>
</action>

Copy to Clipboard

Toggle word wrap

たとえば、リモートビューアー接続ファイルのコンテンツを取得して一時ファイルに保存するには、ユーザーは次のように oVirt Python SDK を使用できます。

# Find the virtual machine:
vm = vms_service.list(search='name=myvm')[0]

# Locate the service that manages the virtual machine, as that is where
the locators are defined:
vm_service = vms_service.vm_service(vm.id)

# Find the graphic console of the virtual machine:
graphics_consoles_service = vm_service.graphics_consoles_service()
graphics_console = graphics_consoles_service.list()[0]

# Generate the remote viewer connection file:
console_service = graphics_consoles_service.console_service(graphics_console.id)
remote_viewer_connection_file = console_service.remote_viewer_connection_file()

# Write the content to file "/tmp/remote_viewer_connection_file.vv"
path = "/tmp/remote_viewer_connection_file.vv"
with open(path, "w") as f:
    f.write(remote_viewer_connection_file)

# Find the virtual machine:
vm = vms_service.list(search='name=myvm')[0]

# Locate the service that manages the virtual machine, as that is where
# the locators are defined:
vm_service = vms_service.vm_service(vm.id)

# Find the graphic console of the virtual machine:
graphics_consoles_service = vm_service.graphics_consoles_service()
graphics_console = graphics_consoles_service.list()[0]

# Generate the remote viewer connection file:
console_service = graphics_consoles_service.console_service(graphics_console.id)
remote_viewer_connection_file = console_service.remote_viewer_connection_file()

# Write the content to file "/tmp/remote_viewer_connection_file.vv"
path = "/tmp/remote_viewer_connection_file.vv"
with open(path, "w") as f:
    f.write(remote_viewer_connection_file)

Copy to Clipboard

Toggle word wrap

リモートビューアー接続ファイルを作成すると、次のように仮想マシングラフィックコンソールに接続できます。

#!/bin/sh -ex

remote-viewer --ovirt-ca-file=/etc/pki/ovirt-engine/ca.pem /tmp/remote_viewer_connection_file.vv

#!/bin/sh -ex

remote-viewer --ovirt-ca-file=/etc/pki/ovirt-engine/ca.pem /tmp/remote_viewer_connection_file.vv

Copy to Clipboard

Toggle word wrap

Expand

表6.837 パラメーターの概要
名前	型	方向	Summary
`remote_viewer_connection_file`	String	Out	`remote-viewer` クライアントと互換性のあるファイルが含まれています。

6.268.3.1. remote_viewer_connection_file
リンクのコピー

remote-viewer クライアントと互換性のあるファイルが含まれています。

ユーザーはこの属性の内容を使用してファイルを作成し、remote-viewer クライアントに渡して仮想マシンのグラフィックコンソールに接続することができます。

6.268.4. remove DELETE
リンクのコピー

仮想マシンからグラフィックコンソールを削除します。

Expand

表6.838 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.268.5. ticket POST
リンクのコピー

この仮想マシンのコンソールにアクセスするための時間制約のある認証トークンを生成します。

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket

Copy to Clipboard

Toggle word wrap

クライアント指定のアクションには、必要に応じて、必要なチケット値および/または有効期限 (秒単位) が含まれます。

いずれの場合も、応答は実際に使用されたチケットの値と有効期限を指定します。

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表6.839 パラメーターの概要
名前	型	方向	Summary
`ticket`	Ticket	In/Out	このコンソールへのアクセスに使用できる、生成されたチケット。

6.269. VmGraphicsConsoles
リンクのコピー

Expand

表6.840 メソッドの概要
名前	Summary
`add`	新しいグラフィックコンソールを仮想マシンに追加します。
`list`	仮想マシンの設定済みグラフィックコンソールをすべてリスト表示します。

6.269.1. add POST
リンクのコピー

新しいグラフィックコンソールを仮想マシンに追加します。

Expand

表6.841 パラメーターの概要
名前	型	方向	Summary
`console`	GraphicsConsole	In/Out

6.269.2. list GET
リンクのコピー

仮想マシンの設定済みグラフィックコンソールをすべてリスト表示します。

重要

返されるグラフィックコンソールリストの順序は保証されません。

Expand

表6.842 パラメーターの概要
名前	型	方向	Summary
`consoles`	GraphicsConsole[]	Out	仮想マシンのグラフィックコンソールのリスト。
`current`	ブール値	In	返されるデータが仮想マシンの次の実行に対応するか、現在の実行に対応するかを指定します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すコンソールの最大数を設定します。

6.269.2.1. current
リンクのコピー

返されるデータが仮想マシンの次の実行に対応するか、現在の実行に対応するかを指定します。

重要

値が true でない限り、address と port の属性は入力されません。

たとえば、address と port の属性など、仮想マシンの現在の実行に関するデータを取得するには、次のようなリクエストを送信します。

GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true

GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true

Copy to Clipboard

Toggle word wrap

デフォルト値は false です。

6.269.2.2. follow
リンクのコピー

6.269.2.3. max
リンクのコピー

返すコンソールの最大数を設定します。指定しない場合、すべてのコンソールが返されます。

6.270. VmHostDevice
リンクのコピー

仮想マシンにアタッチされた個々のホストデバイスを管理するサービス。

Expand

表6.843 メソッドの概要
名前	Summary
`get`	特定の仮想マシンにアタッチされた特定のホストデバイスに関する情報を取得します。
`remove`	このホストデバイスの接続を特定の仮想マシンから削除します。

6.270.1. get GET
リンクのコピー

特定の仮想マシンにアタッチされた特定のホストデバイスに関する情報を取得します。

以下に例を示します。

GET /ovirt-engine/api/vms/123/hostdevices/456

GET /ovirt-engine/api/vms/123/hostdevices/456

Copy to Clipboard

Toggle word wrap

<host_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
  <name>pci_0000_04_00_0</name>
  <capability>pci</capability>
  <iommu_group>30</iommu_group>
  <placeholder>true</placeholder>
  <product id="0x13ba">
    <name>GM107GL [Quadro K2200]</name>
  </product>
  <vendor id="0x10de">
    <name>NVIDIA Corporation</name>
  </vendor>
  <host href="/ovirt-engine/api/hosts/543" id="543"/>
  <parent_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
    <name>pci_0000_00_03_0</name>
  </parent_device>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</host_device>

<host_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
  <name>pci_0000_04_00_0</name>
  <capability>pci</capability>
  <iommu_group>30</iommu_group>
  <placeholder>true</placeholder>
  <product id="0x13ba">
    <name>GM107GL [Quadro K2200]</name>
  </product>
  <vendor id="0x10de">
    <name>NVIDIA Corporation</name>
  </vendor>
  <host href="/ovirt-engine/api/hosts/543" id="543"/>
  <parent_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
    <name>pci_0000_00_03_0</name>
  </parent_device>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</host_device>

Copy to Clipboard

Toggle word wrap

Expand

表6.844 パラメーターの概要
名前	型	方向	Summary
`device`	HostDevice	Out	特定の仮想マシンにアタッチされたホストデバイスに関する情報を取得しました。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.270.1.1. follow
リンクのコピー

6.270.2. remove DELETE
リンクのコピー

このホストデバイスの接続を特定の仮想マシンから削除します。

注記

このデバイスが IOMMU プレースホルダーとして機能する場合、削除することはできません (削除すると、placeholder フラグが true に設定されます)。すべての IOMMU プレースホルダーデバイスは、非プレースホルダーデバイスがなくなると同時に自動的に削除されることに注意してください (指定された IOMMU グループのすべてのデバイスが切り離されます)。

DELETE /ovirt-engine/api/vms/123/hostdevices/456

DELETE /ovirt-engine/api/vms/123/hostdevices/456

Copy to Clipboard

Toggle word wrap

Expand

表6.845 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.271. VmHostDevices
リンクのコピー

仮想マシンにアタッチされたホストデバイスを管理するサービス。

Expand

表6.846 メソッドの概要
名前	Summary
`add`	ターゲットデバイスを指定された仮想マシンにアタッチします。
`list`	指定された仮想マシンに割り当てられているホストデバイスをリスト表示します。

6.271.1. add POST
リンクのコピー

ターゲットデバイスを指定された仮想マシンにアタッチします。

以下に例を示します。

POST /ovirt-engine/api/vms/123/hostdevices

POST /ovirt-engine/api/vms/123/hostdevices

Copy to Clipboard

Toggle word wrap

HostDevice タイプのリクエスト本文の例

<host_device id="123" />

<host_device id="123" />

Copy to Clipboard

Toggle word wrap

注記

ホストデバイスを正常にアタッチするために必要な前提条件は、仮想マシンが必ず 1 つのホストにピニングされていることです。その場合、このホストに関連してデバイス ID が取得されます。

注記

より大きな IOMMU グループの一部である PCI デバイスをアタッチすると、その IOMMU グループの残りのデバイスが "プレースホルダー" としてアタッチされます。その後、これらのデバイスは、true に設定された HostDevice タイプの placeholder 属性を使用して識別されます。

すでに IOMMU プレースホルダーとして機能しているデバイスをアタッチする場合は、そのデバイスに対して明示的な Add 操作を発行するだけで、その placeholder フラグがクリアされ、デバイスが仮想マシンにアクセスできるようになります。

Expand

表6.847 パラメーターの概要
名前	型	方向	Summary
`device`	HostDevice	In/Out	指定された仮想マシンにアタッチするホストデバイス。

6.271.2. list GET
リンクのコピー

指定された仮想マシンに割り当てられているホストデバイスをリスト表示します。

返されるデバイスリストの順序は保証されません。

Expand

表6.848 パラメーターの概要
名前	型	方向	Summary
`device`	HostDevice[]	Out	取得した、指定された仮想マシンにアタッチされているホストデバイスのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すデバイスの最大数を設定します。

6.271.2.1. follow
リンクのコピー

6.271.2.2. max
リンクのコピー

返すデバイスの最大数を設定します。指定しない場合、すべてのデバイスが返されます。

6.272. VmMediatedDevice
リンクのコピー

Expand

表6.849 メソッドの概要
名前	Summary
`get`	仮想マシンの仲介デバイス設定を取得します。
`remove`	仲介デバイスを仮想マシンから削除します。
`update`	仲介デバイスに関する情報を更新します。

6.272.1. get GET
リンクのコピー

仮想マシンの仲介デバイス設定を取得します。

Expand

表6.850 パラメーターの概要
名前	型	方向	Summary
`device`	VmMediatedDevice	Out	仮想マシンの仲介デバイスに関する情報。
`follow`	String	In	たどる必要のある内部リンクを指定します。

6.272.1.1. follow
リンクのコピー

6.272.2. remove DELETE
リンクのコピー

仲介デバイスを仮想マシンから削除します。

Expand

表6.851 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.272.3. update PUT
リンクのコピー

仲介デバイスに関する情報を更新します。

specParams 要素を使用して情報を更新できます。

たとえば、仲介デバイスを更新するには、次のような要求を送信します。

PUT /ovirt-engine/api/vms/123/mediateddevices/00000000-0000-0000-0000-000000000000
<vm_mediated_device>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

PUT /ovirt-engine/api/vms/123/mediateddevices/00000000-0000-0000-0000-000000000000
<vm_mediated_device>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

Copy to Clipboard

Toggle word wrap

応答本文を使用:

<vm_mediated_device href="/ovirt-engine/api/vms/123/mediateddevices/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

<vm_mediated_device href="/ovirt-engine/api/vms/123/mediateddevices/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <spec_params>
    <property>
      <name>mdevType</name>
      <value>nvidia-11</value>
    </property>
  </spec_params>
</vm_mediated_device>

Copy to Clipboard

Toggle word wrap

Expand

表6.852 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`device`	VmMediatedDevice	In/Out	仲介デバイスに関する情報。

6.272.3.1. device
リンクのコピー

仲介デバイスに関する情報。

6.273. VmMediatedDevices
リンクのコピー

仮想マシンの仲介デバイスを管理するサービス。

Expand

表6.853 メソッドの概要
名前	Summary
`add`	新しい仲介デバイスを仮想マシンに追加します。
`list`	仮想マシンの設定済み仲介デバイスをすべてリスト表示します。

6.273.1. add POST
リンクのコピー

新しい仲介デバイスを仮想マシンに追加します。

Expand

表6.854 パラメーターの概要
名前	型	方向	Summary
`device`	VmMediatedDevice	In/Out

6.273.2. list GET
リンクのコピー

仮想マシンの設定済み仲介デバイスをすべてリスト表示します。

返される仲介デバイスリストの順序は保証されません。

Expand

表6.855 パラメーターの概要
名前	型	方向	Summary
`devices`	VmMediatedDevice[]	Out	仮想マシンの仲介デバイスのリスト。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す仲介デバイスの最大数を設定します。

6.273.2.1. follow
リンクのコピー

6.273.2.2. max
リンクのコピー

返す仲介デバイスの最大数を設定します。指定されていない場合は、すべての仲介デバイスが返されます。

6.274. VmNic
リンクのコピー

Expand

表6.856 メソッドの概要
名前	Summary
`activate`
`deactivate`
`get`
`remove`	NIC を削除します。
`update`	NIC を更新します。

6.274.1. activate POST
リンクのコピー

Expand

表6.857 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	アクティベーションを非同期で実行する必要があるかどうかを示します。

6.274.2. deactivate POST
リンクのコピー

Expand

表6.858 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	非アクティブ化を非同期で実行する必要があるかどうかを示します。

6.274.3. get GET
リンクのコピー

Expand

表6.859 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`nic`	Nic	Out

6.274.3.1. follow
リンクのコピー

6.274.4. remove DELETE
リンクのコピー

NIC を削除します。

たとえば、ID 123 の仮想マシンから ID 456 の NIC を削除するには、以下のようなリクエストを送信します。

DELETE /ovirt-engine/api/vms/123/nics/456

DELETE /ovirt-engine/api/vms/123/nics/456

Copy to Clipboard

Toggle word wrap

重要

ホットプラグ機能は、ホットプラグ操作を行う仮想マシンオペレーティングシステムのみをサポートします。オペレーティングシステムの例は次のとおりです。

Red Hat Enterprise Linux 6
Red Hat Enterprise Linux 5
Windows Server 2008 および
Windows Server 2003

Expand

表6.860 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.274.5. update PUT
リンクのコピー

NIC を更新します。

たとえば、ID 123 の仮想マシンに属する 456 を持つ NIC を更新するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/vms/123/nics/456

PUT /ovirt-engine/api/vms/123/nics/456

Copy to Clipboard

Toggle word wrap

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

<nic>
  <name>mynic</name>
  <interface>e1000</interface>
  <vnic_profile id='789'/>
</nic>

<nic>
  <name>mynic</name>
  <interface>e1000</interface>
  <vnic_profile id='789'/>
</nic>

Copy to Clipboard

Toggle word wrap

重要

Red Hat Enterprise Linux 6
Red Hat Enterprise Linux 5
Windows Server 2008 および
Windows Server 2003

Expand

表6.861 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`nic`	Nic	In/Out

6.275. VmNics
リンクのコピー

Expand

表6.862 メソッドの概要
名前	Summary
`add`	仮想マシンに NIC を追加します。
`list`	仮想マシンの NIC のリストを返します。

6.275.1. add POST
リンクのコピー

仮想マシンに NIC を追加します。

次の例では、virtio と NIC プロファイル 456 を使用して、mynic という名前のネットワークインターフェイスを仮想マシン 123 に追加します。

POST /ovirt-engine/api/vms/123/nics

POST /ovirt-engine/api/vms/123/nics

Copy to Clipboard

Toggle word wrap

<nic>
  <name>mynic</name>
  <interface>virtio</interface>
  <vnic_profile id="456"/>
</nic>

<nic>
  <name>mynic</name>
  <interface>virtio</interface>
  <vnic_profile id="456"/>
</nic>

Copy to Clipboard

Toggle word wrap

次の例では、そのリクエストを curl を使用して送信しています。

curl \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--user "admin@internal:mypassword" \
--cacert /etc/pki/ovirt-engine/ca.pem \
--data '
<nic>
  <name>mynic</name>
  <interface>virtio</interface>
  <vnic_profile id="456"/>
</nic>
' \
https://myengine.example.com/ovirt-engine/api/vms/123/nics

curl \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--user "admin@internal:mypassword" \
--cacert /etc/pki/ovirt-engine/ca.pem \
--data '
<nic>
  <name>mynic</name>
  <interface>virtio</interface>
  <vnic_profile id="456"/>
</nic>
' \
https://myengine.example.com/ovirt-engine/api/vms/123/nics

Copy to Clipboard

Toggle word wrap

重要

Red Hat Enterprise Linux 6
Red Hat Enterprise Linux 5
Windows Server 2008 および
Windows Server 2003

Expand

表6.863 パラメーターの概要
名前	型	方向	Summary
`nic`	Nic	In/Out

6.275.2. list GET
リンクのコピー

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

返される NIC リストの順序は保証されません。

Expand

表6.864 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す NIC の最大数を設定します。
`nics`	Nic[]	Out

6.275.2.1. follow
リンクのコピー

6.275.2.2. max
リンクのコピー

返す NIC の最大数を設定します。指定されていない場合は、すべての NIC が返されます。

6.276. VmNumaNode
リンクのコピー

Expand

表6.865 メソッドの概要
名前	Summary
`get`
`remove`	仮想 NUMA ノードを削除します。
`update`	仮想 NUMA ノードを更新します。

6.276.1. get GET
リンクのコピー

Expand

表6.866 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`ノード`	VirtualNumaNode	Out

6.276.1.1. follow
リンクのコピー

6.276.2. remove DELETE
リンクのコピー

仮想 NUMA ノードを削除します。

仮想 NUMA ノードを削除する例:

DELETE /ovirt-engine/api/vms/123/numanodes/456

DELETE /ovirt-engine/api/vms/123/numanodes/456

Copy to Clipboard

Toggle word wrap

注記

まず最高位のインデックスから numa ノードを削除する必要があります。

Expand

表6.867 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.276.3. update PUT
リンクのコピー

仮想 NUMA ノードを更新します。

仮想 NUMA ノードをホスト上の物理 NUMA ノードにピニングする例:

PUT /ovirt-engine/api/vms/123/numanodes/456

PUT /ovirt-engine/api/vms/123/numanodes/456

Copy to Clipboard

Toggle word wrap

リクエスト本文には、以下がが含まれている必要があります。

<vm_numa_node>
  <numa_node_pins>
    <numa_node_pin>
      <index>0</index>
    </numa_node_pin>
  </numa_node_pins>
</vm_numa_node>

<vm_numa_node>
  <numa_node_pins>
    <numa_node_pin>
      <index>0</index>
    </numa_node_pin>
  </numa_node_pins>
</vm_numa_node>

Copy to Clipboard

Toggle word wrap

Expand

表6.868 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`ノード`	VirtualNumaNode	In/Out

6.277. VmNumaNodes
リンクのコピー

Expand

表6.869 メソッドの概要
名前	Summary
`add`	仮想マシンの新しい仮想 NUMA ノードを作成します。
`list`	仮想マシンの仮想 NUMA ノードをリスト表示します。

6.277.1. add POST
リンクのコピー

仮想マシンの新しい仮想 NUMA ノードを作成します。

NUMA ノードの作成例:

POST /ovirt-engine/api/vms/c7ecd2dc/numanodes
Accept: application/xml
Content-type: application/xml

POST /ovirt-engine/api/vms/c7ecd2dc/numanodes
Accept: application/xml
Content-type: application/xml

Copy to Clipboard

Toggle word wrap

リクエスト本文には、以下を含めることができます。

<vm_numa_node>
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>1024</memory>
  <numa_tune_mode>strict</numa_tune_mode>
</vm_numa_node>

<vm_numa_node>
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>1024</memory>
  <numa_tune_mode>strict</numa_tune_mode>
</vm_numa_node>

Copy to Clipboard

Toggle word wrap

Expand

表6.870 パラメーターの概要
名前	型	方向	Summary
`ノード`	VirtualNumaNode	In/Out

6.277.2. list GET
リンクのコピー

仮想マシンの仮想 NUMA ノードをリスト表示します。

返される NUMA ノードのリストの順序は保証されません。

Expand

表6.871 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すノードの最大数を設定します。
`nodes`	VirtualNumaNode[]	Out

6.277.2.1. follow
リンクのコピー

6.277.2.2. max
リンクのコピー

返すノードの最大数を設定します。指定されていない場合は、すべてのノードが返されます。

6.278. VmPool
リンクのコピー

仮想マシンプールを管理するためのサービス。

Expand

表6.872 メソッドの概要
名前	Summary
`allocatevm`	この操作により、仮想マシンが仮想マシンプールに割り当てられます。
`get`	仮想マシンプールを取得します。
`remove`	仮想マシンプールを削除します。
`update`	仮想マシンプールを更新します。

6.278.1. allocatevm POST
リンクのコピー

この操作により、仮想マシンが仮想マシンプールに割り当てられます。

POST /ovirt-engine/api/vmpools/123/allocatevm

POST /ovirt-engine/api/vmpools/123/allocatevm

Copy to Clipboard

Toggle word wrap

仮想マシンの割り当てアクションはアクション固有のパラメーターを実行しないため、リクエストの本文には空の action が含まれている必要があります。

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

Expand

表6.873 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	割り当てを非同期で実行する必要があるかどうかを示します。

6.278.2. get GET
リンクのコピー

仮想マシンプールを取得します。

GET /ovirt-engine/api/vmpools/123

GET /ovirt-engine/api/vmpools/123

Copy to Clipboard

Toggle word wrap

次のような XML 応答が返されます。

<vm_pool id="123">
  <actions>...</actions>
  <name>MyVmPool</name>
  <description>MyVmPool description</description>
  <link href="/ovirt-engine/api/vmpools/123/permissions" rel="permissions"/>
  <max_user_vms>1</max_user_vms>
  <prestarted_vms>0</prestarted_vms>
  <size>100</size>
  <stateful>false</stateful>
  <type>automatic</type>
  <use_latest_template_version>false</use_latest_template_version>
  <cluster id="123"/>
  <template id="123"/>
  <vm id="123">...</vm>
  ...
</vm_pool>

<vm_pool id="123">
  <actions>...</actions>
  <name>MyVmPool</name>
  <description>MyVmPool description</description>
  <link href="/ovirt-engine/api/vmpools/123/permissions" rel="permissions"/>
  <max_user_vms>1</max_user_vms>
  <prestarted_vms>0</prestarted_vms>
  <size>100</size>
  <stateful>false</stateful>
  <type>automatic</type>
  <use_latest_template_version>false</use_latest_template_version>
  <cluster id="123"/>
  <template id="123"/>
  <vm id="123">...</vm>
  ...
</vm_pool>

Copy to Clipboard

Toggle word wrap

Expand

表6.874 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`pool`	VmPool	Out	取得した仮想マシンプール。

6.278.2.1. follow
リンクのコピー

6.278.3. remove DELETE
リンクのコピー

仮想マシンプールを削除します。

DELETE /ovirt-engine/api/vmpools/123

DELETE /ovirt-engine/api/vmpools/123

Copy to Clipboard

Toggle word wrap

Expand

表6.875 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.278.4. update PUT
リンクのコピー

仮想マシンプールを更新します。

PUT /ovirt-engine/api/vmpools/123

PUT /ovirt-engine/api/vmpools/123

Copy to Clipboard

Toggle word wrap

name、description、size、prestarted_vms、および max_user_vms 属性は、仮想マシンプールの作成後に更新できます。

<vmpool>
  <name>VM_Pool_B</name>
  <description>Virtual Machine Pool B</description>
  <size>3</size>
  <prestarted_vms>1</size>
  <max_user_vms>2</size>
</vmpool>

<vmpool>
  <name>VM_Pool_B</name>
  <description>Virtual Machine Pool B</description>
  <size>3</size>
  <prestarted_vms>1</size>
  <max_user_vms>2</size>
</vmpool>

Copy to Clipboard

Toggle word wrap

Expand

表6.876 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`pool`	VmPool	In/Out	更新中の仮想マシンプール。
`seal`	ブール値	In	プール用に作成された仮想マシンを作成後にシールする必要があるかどうかを指定します。

6.278.4.1. seal
リンクのコピー

プール用に作成された仮想マシンを作成後にシールする必要があるかどうかを指定します。

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

たとえば、仮想マシンプールを更新し、作成された追加の仮想マシンをシールするには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/vmpools/123?seal=true

PUT /ovirt-engine/api/vmpools/123?seal=true

Copy to Clipboard

Toggle word wrap

以下のボディーを使用します。

<vmpool>
  <name>VM_Pool_B</name>
  <description>Virtual Machine Pool B</description>
  <size>7</size>
</vmpool>

<vmpool>
  <name>VM_Pool_B</name>
  <description>Virtual Machine Pool B</description>
  <size>7</size>
</vmpool>

Copy to Clipboard

Toggle word wrap

6.279. VmPools
リンクのコピー

仮想マシンプールへの読み取り/書き込みアクセスを提供します。

Expand

表6.877 メソッドの概要
名前	Summary
`add`	新しい仮想マシンプールを作成します。
`list`	使用可能な仮想マシンプールのリストを取得します。

6.279.1. add POST
リンクのコピー

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

新しいプールには、name、cluster、template の属性が必要です。id または name のネストされた属性でクラスターとテンプレートを特定します。

POST /ovirt-engine/api/vmpools

POST /ovirt-engine/api/vmpools

Copy to Clipboard

Toggle word wrap

以下のボディーを使用します。

<vmpool>
  <name>mypool</name>
  <cluster id="123"/>
  <template id="456"/>
</vmpool>

<vmpool>
  <name>mypool</name>
  <cluster id="123"/>
  <template id="456"/>
</vmpool>

Copy to Clipboard

Toggle word wrap

Expand

表6.878 パラメーターの概要
名前	型	方向	Summary
`pool`	VmPool	In/Out	追加するプール。
`seal`	ブール値	In	プール用に作成された仮想マシンを作成後にシールする必要があるかどうかを指定します。

6.279.1.1. seal
リンクのコピー

プール用に作成された仮想マシンを作成後にシールする必要があるかどうかを指定します。

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

たとえば、5 つの仮想マシンを含む仮想マシンプールを作成してそれらをシールするには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/vmpools?seal=true

POST /ovirt-engine/api/vmpools?seal=true

Copy to Clipboard

Toggle word wrap

以下のボディーを使用します。

<vmpool>
  <name>mypool</name>
  <cluster id="123"/>
  <template id="456"/>
  <size>5</size>
</vmpool>

<vmpool>
  <name>mypool</name>
  <cluster id="123"/>
  <template id="456"/>
  <size>5</size>
</vmpool>

Copy to Clipboard

Toggle word wrap

6.279.2. list GET
リンクのコピー

使用可能な仮想マシンプールのリストを取得します。

GET /ovirt-engine/api/vmpools

GET /ovirt-engine/api/vmpools

Copy to Clipboard

Toggle word wrap

以下の応答が返されます。

<vm_pools>
  <vm_pool id="123">
    ...
  </vm_pool>
  ...
</vm_pools>

<vm_pools>
  <vm_pool id="123">
    ...
  </vm_pool>
  ...
</vm_pools>

Copy to Clipboard

Toggle word wrap

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

Expand

表6.879 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプールの最大数を設定します。
`pools`	VmPool[]	Out	取得したプール。
`search`	String	In	返されたプールを制限するために使用されるクエリー文字列。

6.279.2.1. case_sensitive
リンクのコピー

6.279.2.2. follow
リンクのコピー

6.279.2.3. max
リンクのコピー

返すプールの最大数を設定します。この値が指定されていない場合、すべてのプールが返されます。

6.280. VmReportedDevice
リンクのコピー

Expand

表6.880 メソッドの概要
名前	Summary
`get`

6.280.1. get GET
リンクのコピー

Expand

表6.881 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`reported_device`	ReportedDevice	Out

6.280.1.1. follow
リンクのコピー

6.281. VmReportedDevices
リンクのコピー

Expand

表6.882 メソッドの概要
名前	Summary
`list`	仮想マシンの報告されたデバイスのリストを返します。

6.281.1. list GET
リンクのコピー

仮想マシンの報告されたデバイスのリストを返します。

返されるデバイスリストの順序は保証されません。

Expand

表6.883 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すデバイスの最大数を設定します。
`reported_device`	ReportedDevice[]	Out

6.281.1.1. follow
リンクのコピー

6.281.1.2. max
リンクのコピー

返すデバイスの最大数を設定します。指定しない場合、すべてのデバイスが返されます。

6.282. VmSession
リンクのコピー

Expand

表6.884 メソッドの概要
名前	Summary
`get`

6.282.1. get GET
リンクのコピー

Expand

表6.885 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`session`	セッション	Out

6.282.1.1. follow
リンクのコピー

6.283. VmSessions
リンクのコピー

仮想マシンのユーザーセッションに関する情報を提供します。

Expand

表6.886 メソッドの概要
名前	Summary
`list`	この仮想マシンのすべてのユーザーセッションをリスト表示します。

6.283.1. list GET
リンクのコピー

この仮想マシンのすべてのユーザーセッションをリスト表示します。

たとえば、仮想マシン 123 のセッション情報を取得するには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/vms/123/sessions

GET /ovirt-engine/api/vms/123/sessions

Copy to Clipboard

Toggle word wrap

応答本文には、次のような内容が含まれます。

<sessions>
  <session href="/ovirt-engine/api/vms/123/sessions/456" id="456">
    <console_user>true</console_user>
    <ip>
      <address>192.168.122.1</address>
    </ip>
    <user href="/ovirt-engine/api/users/789" id="789"/>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </session>
  ...
</sessions>

<sessions>
  <session href="/ovirt-engine/api/vms/123/sessions/456" id="456">
    <console_user>true</console_user>
    <ip>
      <address>192.168.122.1</address>
    </ip>
    <user href="/ovirt-engine/api/users/789" id="789"/>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </session>
  ...
</sessions>

Copy to Clipboard

Toggle word wrap

返されるセッションリストの順序は保証されません。

Expand

表6.887 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すセッションの最大数を設定します。
`sessions`	Session[]	Out

6.283.1.1. follow
リンクのコピー

6.283.1.2. max
リンクのコピー

返すセッションの最大数を設定します。指定されていない場合は、すべてのセッションが返されます。

6.284. VmWatchdog
リンクのコピー

仮想マシンのウォッチドッグを管理するサービス。

Expand

表6.888 メソッドの概要
名前	Summary
`get`	ウォッチドッグに関する情報を返します。
`remove`	仮想マシンからウォッチドッグを削除します。
`update`	ウォッチドッグの情報を更新します。

6.284.1. get GET
リンクのコピー

ウォッチドッグに関する情報を返します。

Expand

表6.889 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`watchdog`	Watchdog	Out	ウォッチドッグに関する情報です。

6.284.1.1. follow
リンクのコピー

6.284.1.2. watchdog
リンクのコピー

ウォッチドッグに関する情報です。

この情報は、model 要素、action 要素、および仮想マシンへの参照で構成されます。たとえば、以下のようになります。

<watchdogs>
  <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
    <action>poweroff</action>
    <model>i6300esb</model>
  </watchdog>
</watchdogs>

<watchdogs>
  <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
    <action>poweroff</action>
    <model>i6300esb</model>
  </watchdog>
</watchdogs>

Copy to Clipboard

Toggle word wrap

6.284.2. remove DELETE
リンクのコピー

仮想マシンからウォッチドッグを削除します。

たとえば、仮想マシンからウォッチドッグを削除するには、次のようなリクエストを送信します。

DELETE /ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000

DELETE /ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000

Copy to Clipboard

Toggle word wrap

Expand

表6.890 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.284.3. update PUT
リンクのコピー

ウォッチドッグの情報を更新します。

action 要素と model 要素を使用して情報を更新できます。

たとえば、ウォッチドッグを更新するには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/vms/123/watchdogs
<watchdog>
  <action>reset</action>
</watchdog>

PUT /ovirt-engine/api/vms/123/watchdogs
<watchdog>
  <action>reset</action>
</watchdog>

Copy to Clipboard

Toggle word wrap

応答本文を使用:

<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <action>reset</action>
  <model>i6300esb</model>
</watchdog>

<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <action>reset</action>
  <model>i6300esb</model>
</watchdog>

Copy to Clipboard

Toggle word wrap

Expand

表6.891 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`watchdog`	Watchdog	In/Out	ウォッチドッグに関する情報です。

6.284.3.1. watchdog
リンクのコピー

ウォッチドッグに関する情報です。

リクエストデータには、model と action の少なくともどちらかの要素が必要です。応答データには、更新されたウォッチドッグに関する完全な情報が含まれています。

6.285. VmWatchdogs
リンクのコピー

仮想マシンのウォッチドッグをリスト表示します。

Expand

表6.892 メソッドの概要
名前	Summary
`add`	仮想マシンに新しいウォッチドッグを追加します。
`list`	仮想マシンのウォッチドッグのリスト。

6.285.1. add POST
リンクのコピー

仮想マシンに新しいウォッチドッグを追加します。

たとえば、ウォッチドッグを仮想マシンに追加するには、次のようなリクエストを送信します。

POST /ovirt-engine/api/vms/123/watchdogs
<watchdog>
  <action>poweroff</action>
  <model>i6300esb</model>
</watchdog>

POST /ovirt-engine/api/vms/123/watchdogs
<watchdog>
  <action>poweroff</action>
  <model>i6300esb</model>
</watchdog>

Copy to Clipboard

Toggle word wrap

応答本文を使用:

<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <action>poweroff</action>
  <model>i6300esb</model>
</watchdog>

<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <action>poweroff</action>
  <model>i6300esb</model>
</watchdog>

Copy to Clipboard

Toggle word wrap

Expand

表6.893 パラメーターの概要
名前	型	方向	Summary
`watchdog`	Watchdog	In/Out	ウォッチドッグに関する情報です。

6.285.1.1. watchdog
リンクのコピー

ウォッチドッグに関する情報です。

リクエストデータには、model 要素 (i6300esb など) と action 要素 (none、reset、poweroff、dump、pause のいずれか) が含まれている必要があります。応答データには、追加されたウォッチドッグおよび仮想マシンへの参照が含まれます。

6.285.2. list GET
リンクのコピー

仮想マシンのウォッチドッグのリスト。

返されるウォッチドッグリストの順序は保証されません。

Expand

表6.894 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すウォッチドッグの最大数を設定します。
`watchdogs`	Watchdog[]	Out	ウォッチドッグに関する情報です。

6.285.2.1. follow
リンクのコピー

6.285.2.2. max
リンクのコピー

返すウォッチドッグの最大数を設定します。指定しない場合、すべてのウォッチドッグが返されます。

6.285.2.3. watchdogs
リンクのコピー

ウォッチドッグに関する情報です。

この情報は、model 要素、action 要素、および仮想マシンへの参照で構成されます。たとえば、以下のようになります。

<watchdogs>
  <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
    <action>poweroff</action>
    <model>i6300esb</model>
  </watchdog>
</watchdogs>

<watchdogs>
  <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
    <action>poweroff</action>
    <model>i6300esb</model>
  </watchdog>
</watchdogs>

Copy to Clipboard

Toggle word wrap

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"

#!/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"

#!/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>

<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>

<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>

<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>

<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>

<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

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>

<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

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>

<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

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>

<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

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>

<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

GET /ovirt-engine/api/vms?all_content=true

Copy to Clipboard

Toggle word wrap

注記

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

6.286.2.2. case_sensitive
リンクのコピー

6.286.2.3. follow
リンクのコピー

6.286.2.4. ovf_as_ova
リンクのコピー

以下に例を示します。

GET /vms?all_content=true&ovf_as_ova=true

GET /vms?all_content=true&ovf_as_ova=true

Copy to Clipboard

Toggle word wrap

6.287. VnicProfile
リンクのコピー

このサービスは、vNIC プロファイルを管理します。

Expand

表6.898 メソッドの概要
名前	Summary
`get`	vNIC プロファイルの詳細を取得します。
`remove`	vNIC プロファイルを削除します。
`update`	vNIC プロファイルの詳細を更新します。

6.287.1. get GET
リンクのコピー

vNIC プロファイルの詳細を取得します。

Expand

表6.899 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`profile`	VnicProfile	Out

6.287.1.1. follow
リンクのコピー

6.287.2. remove DELETE
リンクのコピー

vNIC プロファイルを削除します。

Expand

表6.900 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.287.3. update PUT
リンクのコピー

vNIC プロファイルの詳細を更新します。

Expand

表6.901 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	更新を非同期的に実行するかどうかを指定します。
`profile`	VnicProfile	In/Out	更新中の vNIC プロファイル。

6.288. VnicProfiles
リンクのコピー

このサービスは、すべての vNIC プロファイルのコレクションを管理します。

Expand

表6.902 メソッドの概要
名前	Summary
`add`	vNIC プロファイルを追加します。
`list`	すべての vNIC プロファイルをリスト表示します。

6.288.1. add POST
リンクのコピー

vNIC プロファイルを追加します。

たとえば、vNIC プロファイル 123 をネットワーク 456 に追加するには、次の宛先にリクエストを送信します。

POST /ovirt-engine/api/networks/456/vnicprofiles

POST /ovirt-engine/api/networks/456/vnicprofiles

Copy to Clipboard

Toggle word wrap

以下のボディーを使用します。

<vnic_profile id="123">
  <name>new_vNIC_name</name>
  <pass_through>
    <mode>disabled</mode>
  </pass_through>
  <port_mirroring>false</port_mirroring>
</vnic_profile>

<vnic_profile id="123">
  <name>new_vNIC_name</name>
  <pass_through>
    <mode>disabled</mode>
  </pass_through>
  <port_mirroring>false</port_mirroring>
</vnic_profile>

Copy to Clipboard

Toggle word wrap

各 VNIC プロファイルにはデフォルトのネットワークフィルターがあることに注意してください。デフォルトのネットワークフィルターの計算方法は、NetworkFilters のドキュメントを参照してください。

注記

外部ネットワーク用に自動作成された vNIC プロファイルには、ネットワークフィルターがありません。

新しい VNIC プロファイル作成の出力は、指定された body 引数によって異なります。ネットワークフィルターが指定されていない場合は、デフォルトのネットワークフィルターが設定されます。以下に例を示します。

<vnic_profile href="/ovirt-engine/api/vnicprofiles/123" id="123">
  <name>new_vNIC_name</name>
  <link href="/ovirt-engine/api/vnicprofiles/123/permissions" rel="permissions"/>
  <pass_through>
    <mode>disabled</mode>
  </pass_through>
  <port_mirroring>false</port_mirroring>
  <network href="/ovirt-engine/api/networks/456" id="456"/>
  <network_filter href="/ovirt-engine/api/networkfilters/789" id="789"/>
</vnic_profile>

<vnic_profile href="/ovirt-engine/api/vnicprofiles/123" id="123">
  <name>new_vNIC_name</name>
  <link href="/ovirt-engine/api/vnicprofiles/123/permissions" rel="permissions"/>
  <pass_through>
    <mode>disabled</mode>
  </pass_through>
  <port_mirroring>false</port_mirroring>
  <network href="/ovirt-engine/api/networks/456" id="456"/>
  <network_filter href="/ovirt-engine/api/networkfilters/789" id="789"/>
</vnic_profile>

Copy to Clipboard

Toggle word wrap

空のネットワークフィルターが指定された場合、VNIC プロファイルのデフォルトネットワークフィルターに関係なく、特定の VNIC プロファイルに対してネットワークフィルターは設定されません。以下に例を示します。

<vnic_profile>
  <name>no_network_filter</name>
  <network_filter/>
</vnic_profile>

<vnic_profile>
  <name>no_network_filter</name>
  <network_filter/>
</vnic_profile>

Copy to Clipboard

Toggle word wrap

特定の有効なネットワークフィルター ID が指定された場合、VNIC プロファイルのデフォルトネットワークフィルターに関係なく、指定されたネットワークフィルターを使用して VNIC プロファイルが設定されます。以下に例を示します。

<vnic_profile>
  <name>user_choice_network_filter</name>
  <network_filter id= "0000001b-001b-001b-001b-0000000001d5"/>
</vnic_profile>

<vnic_profile>
  <name>user_choice_network_filter</name>
  <network_filter id= "0000001b-001b-001b-001b-0000000001d5"/>
</vnic_profile>

Copy to Clipboard

Toggle word wrap

Expand

表6.903 パラメーターの概要
名前	型	方向	Summary
`profile`	VnicProfile	In/Out	追加される vNIC プロファイル。

6.288.2. list GET
リンクのコピー

すべての vNIC プロファイルをリスト表示します。

返される vNIC プロファイルリストの順序は保証されません。

Expand

表6.904 パラメーターの概要
名前	型	方向	Summary
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返すプロファイルの最大数を設定します。
`profiles`	VnicProfile[]	Out	すべての vNIC プロファイルのリスト。

6.288.2.1. follow
リンクのコピー

6.288.2.2. max
リンクのコピー

返すプロファイルの最大数を設定します。指定されていない場合は、すべてのプロファイルが返されます。

6.289. 重み
リンクのコピー

Expand

表6.905 メソッドの概要
名前	Summary
`get`
`remove`

6.289.1. get GET
リンクのコピー

Expand

表6.906 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`重量`	重み	Out

6.289.1.1. follow
リンクのコピー

6.289.2. remove DELETE
リンクのコピー

Expand

表6.907 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除を非同期的に実行するかどうかを指定します。

6.290. 重み
リンクのコピー

Expand

表6.908 メソッドの概要
名前	Summary
`add`	指定したユーザー定義のスケジューリングポリシーに重みを追加します。
`list`	重みのリストを返します。

6.290.1. add POST
リンクのコピー

指定したユーザー定義のスケジューリングポリシーに重みを追加します。

Expand

表6.909 パラメーターの概要
名前	型	方向	Summary
`重量`	重み	In/Out

6.290.2. list GET
リンクのコピー

重みのリストを返します。

返される重みのリストの順序は保証されません。

Expand

表6.910 パラメーターの概要
名前	型	方向	Summary
`filter`	ブール値	In	ユーザーのパーミッションにしたがって、結果をフィルターする必要があるかどうかを示します。
`follow`	String	In	たどる必要のある内部リンクを指定します。
`max`	Integer	In	返す重みの最大数を設定します。
`weights`	Weight[]	Out

6.290.2.1. follow
リンクのコピー

6.290.2.2. max
リンクのコピー

返す重みの最大数を設定します。指定しない場合、すべての重みが返されます。

第7章タイプ
リンクのコピー

このセクションでは、API で使用できるすべてのデータ型を列挙します。

7.1. AccessProtocol enum
リンクのコピー

Gluster ボリュームでサポートされているアクセスプロトコルを表します。gluster と nfs はデフォルトで有効になっています。

Expand

表7.1 値の概要
名前	Summary
`cifs`	CIFS アクセスプロトコル。
`gluster`	Gluster アクセスプロトコル。
`nfs`	NFS アクセスプロトコル。

7.2. Action 構造体
リンクのコピー

Expand

表7.2 属性の概要
名前	型	Summary
`activate`	ブール値
`allow_partial_import`	ブール値
`async`	ブール値
`attachment`	DiskAttachment
`authorized_key`	AuthorizedKey
`auto_pinning_policy`	AutoPinningPolicy
`bricks`	GlusterBrick[]
`certificates`	Certificate[]
`check_connectivity`	ブール値
`clone`	ブール値
`clone_permissions`	ブール値
`cluster`	クラスター
`collapse_snapshots`	ブール値
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`commit_on_success`	ブール値
`connection`	StorageConnection
`connectivity_timeout`	Integer
`correlation_id`	String
`data_center`	DataCenter
`deploy_hosted_engine`	ブール値
`description`	String	プレーンテキストでの人間が判読できる説明。
`details`	GlusterVolumeProfileDetails
`directory`	String
`discard_snapshots`	ブール値
`discovered_targets`	IscsiDetails[]
`disk`	ディスク
`disk_profile`	DiskProfile
`disks`	Disk[]
`exclusive`	ブール値
`fault`	異常
`fence_type`	String
`filename`	String
`filter`	ブール値
`fix_layout`	ブール値
`follow`	String
`force`	ブール値
`grace_period`	GracePeriod
`host`	ホスト
`id`	String	一意の ID
`image`	String
`image_transfer`	ImageTransfer
`import_as_template`	ブール値
`is_attached`	ブール値
`iscsi`	IscsiDetails
`iscsi_targets`	String[]
`job`	ジョブ
`lease`	StorageDomainLease
`logical_units`	LogicalUnit[]
`maintenance_after_restart`	ブール値
`maintenance_enabled`	ブール値
`migrate_vms_in_affinity_closure`	ブール値
`modified_bonds`	HostNic[]
`modified_labels`	NetworkLabel[]
`modified_network_attachments`	NetworkAttachment[]
`name`	String	人間が判読できるプレーンテキストでの名前。
`optimize_cpu_settings`	ブール値
`option`	オプション
`pause`	ブール値
`permission`	Permission
`power_management`	PowerManagement
`proxy_ticket`	ProxyTicket
`quota`	クォータ
`reason`	String
`reassign_bad_macs`	ブール値
`reboot`	ブール値
`registration_configuration`	RegistrationConfiguration
`remote_viewer_connection_file`	String
`removed_bonds`	HostNic[]
`removed_labels`	NetworkLabel[]
`removed_network_attachments`	NetworkAttachment[]
`resolution_type`	String
`restore_memory`	ブール値
`root_password`	String
`seal`	ブール値
`snapshot`	スナップショット
`source_host`	ホスト
`ssh`	Ssh
`status`	String
`stop_gluster_service`	ブール値
`storage_domain`	StorageDomain
`storage_domains`	StorageDomain[]
`succeeded`	ブール値
`synchronized_network_attachments`	NetworkAttachment[]
`template`	テンプレート
`ticket`	Ticket
`timeout`	Integer
`undeploy_hosted_engine`	ブール値
`upgrade_action`	ClusterUpgradeAction
`upgrade_percent_complete`	Integer
`use_cloud_init`	ブール値
`use_ignition`	ブール値
`use_initialization`	ブール値
`use_sysprep`	ブール値
`virtual_functions_configuration`	HostNicVirtualFunctionsConfiguration
`vm`	Vm
`vnic_profile_mappings`	VnicProfileMapping[]
`volatile`	ブール値

7.3. AffinityGroup struct
リンクのコピー

アフィニティーグループは、定義された関係を持つ仮想マシンのグループを表します。

Expand

表7.3 属性の概要
名前	型	Summary
`broken`	ブール値	アフィニティーグループが壊れているかどうかを指定します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`enforcing`	ブール値	アフィニティーグループが、そのアフィニティーグループのメンバーである仮想マシンに適用されるアフィニティーのハード強制とソフト強制のどちらを使用するかを指定します。
`hosts_rule`	AffinityRule	このアフィニティーグループのメンバーである仮想マシンとホストの間に適用されるアフィニティールールを指定します。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`positive`	ブール値	アフィニティーグループが、そのアフィニティーグループのメンバーである仮想マシンに正のアフィニティーと負のアフィニティーのどちらを適用するか指定します。
`priority`	10 進数	アフィニティーグループの優先度。
`vms_rule`	AffinityRule	このアフィニティーグループのメンバーである仮想マシンに適用されるアフィニティールールを指定します。

7.3.1. broken
リンクのコピー

アフィニティーグループが壊れているかどうかを指定します。ルールのいずれかが満たされない場合、アフィニティーグループは壊れていると見なされます。壊れたフィールドは、エンジンのコンピュートフィールドです。そのため、このフィールドは GET リクエストでのみ使用できます。

7.3.2. enforcing
リンクのコピー

アフィニティーグループが、そのアフィニティーグループのメンバーである仮想マシンに適用されるアフィニティーのハード強制とソフト強制のどちらを使用するかを指定します。

警告

この属性はエンジンのバージョン 4.1 以降非推奨となり、将来削除されることに注意してください。今後は vms_rule 属性を使用してください。

7.3.3. positive
リンクのコピー

アフィニティーグループが、そのアフィニティーグループのメンバーである仮想マシンに正のアフィニティーと負のアフィニティーのどちらを適用するか指定します。

警告

この属性はエンジンのバージョン 4.1 以降非推奨となり、将来削除されることに注意してください。今後は vms_rule 属性を使用してください。

Expand

表7.4 リンクの概要
名前	型	Summary
`cluster`	クラスター	アフィニティーグループが適用されるクラスターへの参照。
`host_labels`	AffinityLabel[]	このアフィニティーグループに割り当てられたすべてのホストラベルのリスト。
`hosts`	Host[]	このアフィニティーグループに割り当てられたすべてのホストのリスト。
`vm_labels`	AffinityLabel[]	このアフィニティーグループに割り当てられたすべての仮想マシンラベルのリスト。
`vms`	Vm[]	このアフィニティーグループに割り当てられたすべての仮想マシンのリスト。

7.4. AffinityLabel 構造体
リンクのコピー

アフィニティーラベルは、仮想マシンのスケジューリングに影響を与える可能性があります。利用可能なホストからサブクラスターを作成するために最も頻繁に使用されます。

Expand

表7.5 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`has_implicit_affinity_group`	ブール値	このプロパティーは、ラベルの従来の動作を有効にします。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`read_only`	ブール値	`read_only` プロパティーは、変更できないラベルをマークします。

7.4.1. has_implicit_affinity_group
リンクのコピー

このプロパティーは、ラベルの従来の動作を有効にします。true の場合、ラベルは仮想マシンからホストへの positive enforcing アフィニティーグループとして動作します。

このパラメーターは、互換性のあるバージョン 4.3 以下のクラスターでのみ使用されます。

7.4.2. read_only
リンクのコピー

read_only プロパティーは、変更できないラベルをマークします。これは通常、内部で生成されたラベルをリストする場合に該当します。

Expand

表7.6 リンクの概要
名前	型	Summary
`hosts`	Host[]	このスケジューリングラベルを使用してラベル付けされたホストのリスト。
`vms`	Vm[]	このスケジューリングラベルを使用してラベル付けされた仮想マシンのリスト。

7.5. AffinityRule 構造体
リンクのコピー

アフィニティーグループの汎用ルール定義。サポートされている各リソースタイプ (仮想マシン、ホスト) は、個別のルールによって制御されます。そのため、定義された仮想マシン間にアフィニティーはないが、定義された仮想マシンと仮想ホストの間にはハードアフィニティーがあるなどのルールを表現できます。

Expand

表7.7 属性の概要
名前	型	Summary
`enabled`	ブール値	アフィニティーグループがこのルールを使用するかどうかを指定します。
`enforcing`	ブール値	アフィニティーグループが、このルールで制御されるリソースに適用されるアフィニティーのハード強制とソフト強制のどちらを使用するかを指定します。
`positive`	ブール値	アフィニティーグループが、このルールによって制御されるリソースに正のアフィニティーと負のアフィニティーのどちらを適用するか指定します。

7.5.1. enabled
リンクのコピー

アフィニティーグループがこのルールを使用するかどうかを指定します。この属性は作成時に任意であり、提供されない場合は true とみなされます。この属性が更新操作で指定されない場合、AffinityGroup positive 属性も設定されていれば true と見なされます。enabled 属性と positive 属性の両方が欠落している場合、バックエンドの enabled 値は保持されます。

7.5.2. enforcing
リンクのコピー

アフィニティーグループが、このルールで制御されるリソースに適用されるアフィニティーのハード強制とソフト強制のどちらを使用するかを指定します。この引数は、ルールが有効な場合は必須であり、ルールが無効な場合は無視されます。

7.5.3. positive
リンクのコピー

アフィニティーグループが、このルールによって制御されるリソースに正のアフィニティーと負のアフィニティーのどちらを適用するか指定します。この引数は、ルールが有効な場合は必須であり、ルールが無効な場合は無視されます。

7.6. Agent 構造体
リンクのコピー

フェンスエージェントを表すタイプ。

Expand

表7.8 属性の概要
名前	型	Summary
`address`	String	フェンスエージェントのアドレス。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`concurrent`	ブール値	エージェントを同時に使用するか、順次使用するかを指定します。
`description`	String	プレーンテキストでの人間が判読できる説明。
`encrypt_options`	ブール値	オプションを暗号化するかどうかを指定します。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`options`	Option[]	フェンスエージェントオプション (キーと値のペアのコンマ区切りリスト)。
`order`	Integer	他のエージェントと一緒に使用する場合のこのエージェントの順序。
`password`	String	フェンスエージェントのパスワード。
`port`	Integer	フェンスエージェントのポート。
`type`	String	フェンスエージェントのタイプ。
`username`	String	フェンスエージェントのユーザー名。

Expand

表7.9 リンクの概要
名前	型	Summary
`host`	ホスト	ホストサービスへの参照。

7.6.1. host
リンクのコピー

ホストサービスへの参照。各フェンスエージェントは、1 つのホストに属します。

7.7. AgentConfiguration 構造体
リンクのコピー

非推奨エージェントの設定オプション。

Red Hat Virtualization 4.4.0 以降、OpenStack Neutron エージェントのデプロイメントが削除されたため、無視されます。OpenStack ホストのデプロイメントは、Red Hat OpenStack Platform Director または TripleO によって実行できます。

Expand

表7.10 属性の概要
名前	型	Summary
`address`	String
`broker_type`	MessageBrokerType
`network_mappings`	String	Red Hat Virtualization 4 以降、Open vSwitch インターフェイスのマッピングは VDSM によって管理されるため、使用は推奨しません。
`password`	String
`port`	Integer
`username`	String

7.7.1. network_mappings
リンクのコピー

Red Hat Virtualization 4.2.0 以降、Open vSwitch インターフェイスのマッピングは VDSM によって管理されるため、使用は推奨しません。

7.8. Api 構造体
リンクのコピー

このタイプには、API の root サービスによって返される情報が含まれます。

その情報を取得するには、次のようなリクエストを送信します。

GET /ovirt-engine/api

GET /ovirt-engine/api

Copy to Clipboard

Toggle word wrap

結果は以下のようになります。

<api>
  <link rel="hosts" href="/ovirt-engine/api/hosts"/>
  <link rel="vms" href="/ovirt-engine/api/vms"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.1.0_master</full_version>
      <major>4</major>
      <minor>1</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <link rel="templates/blank" href="..."/>
    <link rel="tags/root" href="..."/>
  </special_objects>
  <summary>
    <vms>
      <total>10</total>
      <active>3</active>
    </vms>
    <hosts>
      <total>2</total>
      <active>2</active>
    </hosts>
    <users>
      <total>8</total>
      <active>2</active>
    </users>
    <storage_domains>
      <total>2</total>
      <active>2</active>
    </storage_domains>
  </summary>
  <time>2016-12-12T12:22:25.866+01:00</time>
</api>

<api>
  <link rel="hosts" href="/ovirt-engine/api/hosts"/>
  <link rel="vms" href="/ovirt-engine/api/vms"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.1.0_master</full_version>
      <major>4</major>
      <minor>1</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <link rel="templates/blank" href="..."/>
    <link rel="tags/root" href="..."/>
  </special_objects>
  <summary>
    <vms>
      <total>10</total>
      <active>3</active>
    </vms>
    <hosts>
      <total>2</total>
      <active>2</active>
    </hosts>
    <users>
      <total>8</total>
      <active>2</active>
    </users>
    <storage_domains>
      <total>2</total>
      <active>2</active>
    </storage_domains>
  </summary>
  <time>2016-12-12T12:22:25.866+01:00</time>
</api>

Copy to Clipboard

Toggle word wrap

Expand

表7.11 属性の概要
名前	型	Summary
`product_info`	ProductInfo	製品名、ベンダー名、バージョンなど、製品に関する情報。
`special_objects`	SpecialObjects	空のテンプレートやタグ階層のルートなどの、特別なオブジェクトへの参照。
`summary`	ApiSummary	仮想マシン、ホスト、ストレージドメインなどの関連オブジェクトの総数を含む概要。
`time`	日付	この情報が生成された日時。

Expand

表7.12 リンクの概要
名前	型	Summary
`authenticated_user`	User	認証されたユーザーへの参照。
`effective_user`	User	実効ユーザーへの参照。

7.8.1. authenticated_user
リンクのコピー

認証されたユーザーへの参照。

認証されたユーザーは、現在の要求を受け入れるためにクレデンシャルが検証されたユーザーです。システムの現在のバージョンでは、認証されたユーザーと実効ユーザーは常に同じです。今後、ユーザー偽装に対するサポートが導入されると、同じではなくなる可能性があります。

7.8.2. effective_user
リンクのコピー

実効ユーザーへの参照。

実効ユーザーは、現在のリクエスト中にそのパーミッションが適用されるユーザーです。システムの現在のバージョンでは、認証されたユーザーと実効ユーザーは常に同じです。今後、ユーザー偽装に対するサポートが導入されると、同じではなくなる可能性があります。

7.9. ApiSummary 構造体
リンクのコピー

仮想マシン、ホスト、ストレージドメインなどの関連オブジェクトの総数を含む概要。

Expand

表7.13 属性の概要
名前	型	Summary
`hosts`	ApiSummaryItem	ホストの概要。
`storage_domains`	ApiSummaryItem	ストレージドメインの概要。
`ユーザー`	ApiSummaryItem	ユーザーの概要。
`vms`	ApiSummaryItem	仮想マシンの概要。

7.10. ApiSummaryItem struct
リンクのコピー

このタイプには、API 概要の項目が含まれます。各項目には、ある種類のオブジェクトの合計数とアクティブな数が含まれています。

Expand

表7.14 属性の概要
名前	型	Summary
`active`	Integer	アクティブなオブジェクトの総数。
`total`	Integer	オブジェクトの総数。

7.11. Application 構造体
リンクのコピー

仮想マシンにインストールされたアプリケーションを表します。仮想マシンのオペレーティングシステムにアプリケーションをデプロイすると、ゲストエージェントによってアプリケーションが報告されます。

その情報を取得するには、次のようなリクエストを送信します。

GET /ovirt-engine/api/vms/123/applications/456

GET /ovirt-engine/api/vms/123/applications/456

Copy to Clipboard

Toggle word wrap

結果は以下のようになります。

<application href="/ovirt-engine/api/vms/123/applications/456" id="456">
  <name>application-test-1.0.0-0.el7</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>

<application href="/ovirt-engine/api/vms/123/applications/456" id="456">
  <name>application-test-1.0.0-0.el7</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>

Copy to Clipboard

Toggle word wrap

Expand

表7.15 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.16 リンクの概要
名前	型	Summary
`vm`	Vm	アプリケーションがインストールされている仮想マシンへの参照。

7.12. アーキテクチャー enum
リンクのコピー

Expand

表7.17 値の概要
名前	Summary
`aarch64`	AARCH64 CPU アーキテクチャー。
`ppc64`
`s390x`	IBM S390X CPU アーキテクチャー。
`undefined`
`x86_64`

7.12.1. s390x
リンクのコピー

IBM S390X CPU アーキテクチャー。

S390X アーキテクチャーで実行されている仮想マシンおよびクラスターに対して指定する必要があります。

S390 は、一般的なマシンアーキテクチャーまたはその 31 ビットバリアントのいずれかを記述するために、あいまいな方法で使用されることが多いことに注意してください。S390X は、X86_64 や PPC64 などの他のアーキテクチャーと一致する 64 ビットアーキテクチャー専用に使用されます。

7.13. AuthorizedKey 構造体
リンクのコピー

Expand

表7.18 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`key`	String
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.19 リンクの概要
名前	型	Summary
`user`	User

7.14. AutoNumaStatus enum
リンクのコピー

Expand

表7.20 値の概要
名前	Summary
`disable`
`enable`
`unknown`

7.15. AutoPinningPolicy enum
リンクのコピー

CPU および NUMA ピニングポリシーを表すタイプ。

重要

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

Expand

表7.21 値の概要
名前	Summary
`adjust`	CPU と NUMA ピニングは、専用ホストによって設定されます。
`disabled`	CPU と NUMA ピニングは計算されません。
`existing`	CPU と NUMA ピニングは、仮想マシンの現在の状態によって設定されます。

7.15.1. adjust
リンクのコピー

CPU と NUMA ピニングは、専用ホストによって設定されます。

現時点では、CPU と NUMA ピニングが専用のホスト CPU トポロジーを使用することを意味します。仮想マシンの設定は、可能な限り最高のパフォーマンスが得られるように、ホストに合わせて自動的に設定されます。

7.15.2. disabled
リンクのコピー

CPU と NUMA ピニングは計算されません。

現時点では、CPU と NUMA ピニングが現在の仮想マシン設定に対して計算されないことを意味します。デフォルトでは、仮想マシントポロジーは 1 ソケット、1 コア、および 1 スレッドに設定されています。

7.15.3. existing
リンクのコピー

CPU と NUMA ピニングは、仮想マシンの現在の状態によって設定されます。

現時点では、CPU と NUMA ピニングが提供された仮想マシンの CPU トポロジーを使用することを意味します。CPU トポロジーが指定されていない場合は、エンジンのデフォルト (1 ソケット、1 コア、および 1 スレッドで設定された仮想マシントポロジー) が使用されます。

7.16. Backup 構造体
リンクのコピー

Expand

表7.22 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`creation_date`	日付	バックアップ作成日。
`description`	String	プレーンテキストでの人間が判読できる説明。
`from_checkpoint_id`	String	増分バックアップを開始するチェックポイント ID。
`id`	String	一意の ID
`modification_date`	日付	バックアップの変更日。
`name`	String	人間が判読できるプレーンテキストでの名前。
`phase`	BackupPhase	バックアップ操作のフェーズ。
`to_checkpoint_id`	String	このバックアップ操作によって作成されたチェックポイント ID。

7.16.1. to_checkpoint_id
リンクのコピー

このバックアップ操作によって作成されたチェックポイント ID。この ID は、次の増分バックアップで fromCheckpointId として使用できます。

Expand

表7.23 リンクの概要
名前	型	Summary
`disks`	Disk[]	仮想マシンのバックアップに含まれるディスクのリスト。
`host`	ホスト	バックアップの開始に使用されたホスト。
`snapshot`	スナップショット	バックアップがスナップショットを使用している場合は、作成されたスナップショットへの参照。
`vm`	Vm	バックアップに関連付けられた仮想マシンへの参照。

7.17. BackupPhase enum
リンクのコピー

Expand

表7.24 値の概要
名前	Summary
`failed`	バックアップに失敗したことを示す最終フェーズ。
`finalizing`	このフェーズでは、バックアップを完了して関連するディスクのロックを解除するために、バックアップで 'stop_backup' 操作が呼び出されます。
`initializing`	バックアップの初期段階。
`ready`	このフェーズは、関連するディスクのバックアップ URL の使用準備が整い、イメージ転送を使用してダウンロードされていることを意味します。
`starting`	フェーズは、vdsm/libvirt で 'start_backup' 操作を呼び出す前に設定されます (つまり、フローを完了するには 'stop_backup' を呼び出す必要があります)。
`succeeded`	バックアップが正常に終了したことを示す最終フェーズ。

7.17.1. initializing
リンクのコピー

バックアップの初期段階。エンティティー作成時に設定されます。

7.18. Balance 構造体
リンクのコピー

Expand

表7.25 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.26 リンクの概要
名前	型	Summary
`scheduling_policy`	SchedulingPolicy
`scheduling_policy_unit`	SchedulingPolicyUnit

7.19. BIOS 構造体
リンクのコピー

Expand

表7.27 属性の概要
名前	型	Summary
`boot_menu`	BootMenu
`type`	BiosType	チップセットと BIOS タイプの組み合わせ。

7.20. BiosType enum
リンクのコピー

チップセットと BIOS タイプの組み合わせを表すタイプ。

Expand

表7.28 値の概要
名前	Summary
`cluster_default`	クラスター全体のデフォルトを使用します。
`i440fx_sea_bios`	SeaBIOS を搭載した i440fx チップセット。
`q35_ovmf`	OVMF (UEFI) BIOS を搭載した q35 チップセット。
`q35_sea_bios`	SeaBIOS を搭載した q35 チップセット。
`q35_secure_boot`	SecureBoot が有効な OVMF (UEFI) BIOS を搭載した q35 チップセット。

7.20.1. cluster_default
リンクのコピー

クラスター全体のデフォルトを使用します。

この値はクラスターには使用できません。

7.20.2. i440fx_sea_bios
リンクのコピー

SeaBIOS を搭載した i440fx チップセット。

x86 以外のアーキテクチャーでは、これが許可されている唯一のデフォルト以外の値です。

7.21. BlockStatistic 構造体
リンクのコピー

Expand

表7.29 属性の概要
名前	型	Summary
`statistics`	Statistic[]

7.22. Bonding 構造体
リンクのコピー

ネットワークインターフェイスボンドを表します。

Expand

表7.30 属性の概要
名前	型	Summary
`ad_partner_mac`	Mac	モード 4 のパートナーボンディングの `ad_partner_mac` プロパティー。
`options`	Option[]	ボンディングインターフェイスの option 要素のリスト。
`slaves`	HostNic[]	結合されたインターフェイスの slave NIC のリスト。

7.22.1. ad_partner_mac
リンクのコピー

モード 4 のパートナーボンディングの ad_partner_mac プロパティー。ボンディングモード 4 は 802.3ad 標準であり、動的リンクアグリゲーションとも呼ばれます。詳細は、Wikipedia および Presentation を参照してください。ad_partner_mac は、ボンディングのもう一方の端にあるシステム (スイッチ) の MAC アドレスです。このパラメーターは読み取り専用です。設定してもボンディングには影響しません。これは、ボンディングが配置されているシステムの /sys/class/net/bondX/bonding/ad_partner_mac ファイルから取得されます。

7.22.2. options
リンクのコピー

ボンディングインターフェイスの option 要素のリスト。各オプションには、プロパティー名と値の属性が含まれています。ボンディングインターフェイスを追加する場合にのみ必要です。

7.22.3. slaves
リンクのコピー

結合されたインターフェイスの slave NIC のリスト。ボンディングインターフェイスを追加する場合にのみ必要です。

Expand

表7.31 リンクの概要
名前	型	Summary
`active_slave`	HostNic	それをサポートするモード (active-backup、balance-alb、balance-tlb) でのボンディングの `active_slave` プロパティー。

7.22.4. active_slave
リンクのコピー

それをサポートするモード (active-backup、balance-alb、balance-tlb) でのボンディングの active_slave プロパティー。詳細は、Linux ドキュメントを参照してください。このパラメーターは読み取り専用です。設定してもボンディングには影響しません。これは、ボンディングが配置されているシステムの /sys/class/net/bondX/bonding/active_slave ファイルから取得されます。

以下に例を示します。

GET /ovirt-engine/api/hosts/123/nics/321

GET /ovirt-engine/api/hosts/123/nics/321

Copy to Clipboard

Toggle word wrap

以下を応答します。

<host_nic href="/ovirt-engine/api/hosts/123/nics/321" id="321">
  ...
  <bonding>
    <slaves>
      <host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456" />
      ...
    </slaves>
    <active_slave href="/ovirt-engine/api/hosts/123/nics/456" id="456" />
  </bonding>
  ...
</host_nic>

<host_nic href="/ovirt-engine/api/hosts/123/nics/321" id="321">
  ...
  <bonding>
    <slaves>
      <host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456" />
      ...
    </slaves>
    <active_slave href="/ovirt-engine/api/hosts/123/nics/456" id="456" />
  </bonding>
  ...
</host_nic>

Copy to Clipboard

Toggle word wrap

7.23. Bookmark 構造体
リンクのコピー

システム内のブックマークを表します。

Expand

表7.32 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`value`	String	エンジン内の検索を表すブックマーク値。

7.24. Boot 構造体
リンクのコピー

仮想マシンのブートシーケンスの設定。

Expand

表7.33 属性の概要
名前	型	Summary
`devices`	BootDevice[]	起動デバイスの順序付きリスト。

7.24.1. devices
リンクのコピー

起動デバイスの順序付きリスト。仮想マシンは、指定された起動デバイスから指定された順序で起動しようとします。

7.25. BootDevice enum
リンクのコピー

仮想マシンが起動できるデバイスの種類を表します。

Expand

表7.34 値の概要
名前	Summary
`cdrom`	CD-ROM から起動します。
`hd`	ハードドライブから起動します。
`network`	PXE を使用して、ネットワークから起動します。

7.25.1. cdrom
リンクのコピー

CD-ROM から起動します。CD-ROM は、仮想マシンが属する ata センターにアタッチされた ISO ドメインで使用可能な ISO ファイルのリストから選択できます。

7.25.2. network
リンクのコピー

PXE を使用して、ネットワークから起動します。仮想マシンが接続されているネットワーク上で PXE が設定されている必要があります。

7.26. BootMenu struct
リンクのコピー

仮想マシンとテンプレートの起動メニュー設定を表します。

Expand

表7.35 属性の概要
名前	型	Summary
`enabled`	ブール値	この仮想マシン (またはテンプレート) に対して起動メニューが有効になっているかどうかを示します。

7.27. BootProtocol enum
リンクのコピー

NIC への IP アドレス割り当て方法のオプションを定義します。

Expand

表7.36 値の概要
名前	Summary
`autoconf`	ステートレスアドレスの自動設定。
`dhcp`	Dynamic host configuration protocol (DHCP)
`none`	アドレス設定なし。
`poly_dhcp_autoconf`	ステートレスアドレス自動設定 (SLAAC) と併用する DHCP。
`static`	静的に定義されたアドレス、マスク、およびゲートウェイ。

7.27.1. autoconf
リンクのコピー

ステートレスアドレスの自動設定。

このメカニズムは RFC 4862 で定義されています。詳細は、こちらの Wikipedia の記事を参照してください。

注記

この値は、IPv6 アドレスに対してのみ有効です。

7.27.2. dhcp
リンクのコピー

Dynamic host configuration protocol (DHCP)

詳細は、こちらの Wikipedia の記事を参照してください。

7.27.3. poly_dhcp_autoconf
リンクのコピー

ステートレスアドレス自動設定 (SLAAC) と併用する DHCP。

SLAAC メカニズムは RFC 4862 で定義されています。詳細は、Stateless address auto-configuration の記事および DHCP アーティクルを参照してください。

注記

この値は、IPv6 アドレスに対してのみ有効です。

7.28. BrickProfileDetail 構造体
リンクのコピー

Expand

表7.37 属性の概要
名前	型	Summary
`profile_details`	ProfileDetail[]

Expand

表7.38 リンクの概要
名前	型	Summary
`brick`	GlusterBrick

7.29. Cdrom 構造体
リンクのコピー

Expand

表7.39 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`file`	File
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.40 リンクの概要
名前	型	Summary
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.29.1. vms
リンクのコピー

このデバイスを使用する仮想マシンへの参照。デバイスは複数の仮想マシンで使用できます。たとえば、共有ディスクは 2 つ以上の仮想マシンで同時に使用することができます。

7.30. Certificate 構造体
リンクのコピー

Expand

表7.41 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`content`	String
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`organization`	String
`サブジェクト (subject)`	String

7.31. Checkpoint 構造体
リンクのコピー

Expand

表7.42 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`creation_date`	日付	チェックポイントの作成日。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`parent_id`	String	親チェックポイント ID。
`state`	CheckpointState	チェックポイントの状態。

Expand

表7.43 リンクの概要
名前	型	Summary
`disks`	Disk[]	バックアップチェックポイントに含まれるディスクのリスト。
`vm`	Vm	チェックポイントに関連付けられた仮想マシンへの参照。

7.32. CheckpointState enum
リンクのコピー

Expand

表7.44 値の概要
名前	Summary
`created`	チェックポイントの初期状態。
`invalid`	INVALID 状態は、チェックポイントを増分バックアップに使用できなくなり、削除する必要がある場合に設定されます (たとえば、古い仮想マシンスナップショットにコミットした後)。

7.32.1. created
リンクのコピー

チェックポイントの初期状態。エンティティー作成時に設定されます。

7.33. CloudInit struct
リンクのコピー

cloud-init 設定を指定する非推奨のタイプ。

このタイプは非推奨となり、Initialization タイプ内の代替属性に置き換えられました。詳細は、cloud_init 属性のドキュメントを参照してください。

Expand

表7.45 属性の概要
名前	型	Summary
`authorized_keys`	AuthorizedKey[]
`files`	File[]
`host`	ホスト
`network_configuration`	NetworkConfiguration
`regenerate_ssh_keys`	ブール値
`timezone`	String
`ユーザー`	User[]

7.34. CloudInitNetworkProtocol enum
リンクのコピー

cloud-init プロトコルの値を定義します。このプロトコルは、cloud-init によって処理されるために仮想マシンに渡される前に、cloud-init ネットワークパラメーターがどのようにフォーマットされるかを決定します。

サポートされるプロトコルは、cloud-init のバージョンに依存します。詳細は、ネットワーク設定ソースを参照してください。

Expand

表7.46 値の概要
名前	Summary
`eni`	レガシープロトコル。
`openstack_metadata`	IPv6 などをサポートする ENI プロトコルの後継。

7.34.1. eni
リンクのコピー

レガシープロトコル。IPv6 には対応していません。詳細は、ネットワーク設定 ENI(Legacy) を参照してください。

7.34.2. openstack_metadata
リンクのコピー

IPv6 などをサポートする ENI プロトコルの後継。これはデフォルト値です。詳細は、API: Proxy neutron configuration to guest instance を参照してください。

7.35. Cluster 構造体
リンクのコピー

クラスターのタイプの表現。

クラスターの JSON の表現。

{
  "cluster" : [ {
    "ballooning_enabled" : "false",
    "cpu" : {
      "architecture" : "x86_64",
      "type" : "Intel SandyBridge Family"
    },
    "custom_scheduling_policy_properties" : {
      "property" : [ {
        "name" : "HighUtilization",
        "value" : "80"
      }, {
        "name" : "CpuOverCommitDurationMinutes",
        "value" : "2"
      } ]
    },
    "error_handling" : {
      "on_error" : "migrate"
    },
    "fencing_policy" : {
      "enabled" : "true",
      "skip_if_connectivity_broken" : {
        "enabled" : "false",
        "threshold" : "50"
      },
      "skip_if_gluster_bricks_up" : "false",
      "skip_if_gluster_quorum_not_met" : "false",
      "skip_if_sd_active" : {
        "enabled" : "false"
      }
    },
    "gluster_service" : "false",
    "firewall_type" : "iptables",
    "ha_reservation" : "false",
    "ksm" : {
      "enabled" : "true",
      "merge_across_nodes" : "true"
    },
    "memory_policy" : {
      "over_commit" : {
        "percent" : "100"
      },
      "transparent_hugepages" : {
        "enabled" : "true"
      }
    },
    "migration" : {
      "auto_converge" : "inherit",
      "bandwidth" : {
        "assignment_method" : "auto"
      },
      "compressed" : "inherit",
      "policy" : {
        "id" : "00000000-0000-0000-0000-000000000000"
      }
    },
    "required_rng_sources" : {
      "required_rng_source" : [ "random" ]
    },
    "switch_type" : "legacy",
    "threads_as_cores" : "false",
    "trusted_service" : "false",
    "tunnel_migration" : "false",
    "version" : {
      "major" : "4",
      "minor" : "1"
    },
    "virt_service" : "true",
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "mac_pool" : {
      "href" : "/ovirt-engine/api/macpools/456",
      "id" : "456"
    },
    "scheduling_policy" : {
      "href" : "/ovirt-engine/api/schedulingpolicies/789",
      "id" : "789"
    },
    "actions" : {
      "link" : [ {
        "href" : "/ovirt-engine/api/clusters/234/resetemulatedmachine",
        "rel" : "resetemulatedmachine"
      } ]
    },
    "name" : "Default",
    "description" : "The default server cluster",
    "href" : "/ovirt-engine/api/clusters/234",
    "id" : "234",
    "link" : [ {
      "href" : "/ovirt-engine/api/clusters/234/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/cpuprofiles",
      "rel" : "cpuprofiles"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/networkfilters",
      "rel" : "networkfilters"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/networks",
      "rel" : "networks"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/affinitygroups",
      "rel" : "affinitygroups"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/glusterhooks",
      "rel" : "glusterhooks"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/glustervolumes",
      "rel" : "glustervolumes"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/enabledfeatures",
      "rel" : "enabledfeatures"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/externalnetworkproviders",
      "rel" : "externalnetworkproviders"
    } ]
  } ]
}

{
  "cluster" : [ {
    "ballooning_enabled" : "false",
    "cpu" : {
      "architecture" : "x86_64",
      "type" : "Intel SandyBridge Family"
    },
    "custom_scheduling_policy_properties" : {
      "property" : [ {
        "name" : "HighUtilization",
        "value" : "80"
      }, {
        "name" : "CpuOverCommitDurationMinutes",
        "value" : "2"
      } ]
    },
    "error_handling" : {
      "on_error" : "migrate"
    },
    "fencing_policy" : {
      "enabled" : "true",
      "skip_if_connectivity_broken" : {
        "enabled" : "false",
        "threshold" : "50"
      },
      "skip_if_gluster_bricks_up" : "false",
      "skip_if_gluster_quorum_not_met" : "false",
      "skip_if_sd_active" : {
        "enabled" : "false"
      }
    },
    "gluster_service" : "false",
    "firewall_type" : "iptables",
    "ha_reservation" : "false",
    "ksm" : {
      "enabled" : "true",
      "merge_across_nodes" : "true"
    },
    "memory_policy" : {
      "over_commit" : {
        "percent" : "100"
      },
      "transparent_hugepages" : {
        "enabled" : "true"
      }
    },
    "migration" : {
      "auto_converge" : "inherit",
      "bandwidth" : {
        "assignment_method" : "auto"
      },
      "compressed" : "inherit",
      "policy" : {
        "id" : "00000000-0000-0000-0000-000000000000"
      }
    },
    "required_rng_sources" : {
      "required_rng_source" : [ "random" ]
    },
    "switch_type" : "legacy",
    "threads_as_cores" : "false",
    "trusted_service" : "false",
    "tunnel_migration" : "false",
    "version" : {
      "major" : "4",
      "minor" : "1"
    },
    "virt_service" : "true",
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "mac_pool" : {
      "href" : "/ovirt-engine/api/macpools/456",
      "id" : "456"
    },
    "scheduling_policy" : {
      "href" : "/ovirt-engine/api/schedulingpolicies/789",
      "id" : "789"
    },
    "actions" : {
      "link" : [ {
        "href" : "/ovirt-engine/api/clusters/234/resetemulatedmachine",
        "rel" : "resetemulatedmachine"
      } ]
    },
    "name" : "Default",
    "description" : "The default server cluster",
    "href" : "/ovirt-engine/api/clusters/234",
    "id" : "234",
    "link" : [ {
      "href" : "/ovirt-engine/api/clusters/234/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/cpuprofiles",
      "rel" : "cpuprofiles"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/networkfilters",
      "rel" : "networkfilters"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/networks",
      "rel" : "networks"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/affinitygroups",
      "rel" : "affinitygroups"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/glusterhooks",
      "rel" : "glusterhooks"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/glustervolumes",
      "rel" : "glustervolumes"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/enabledfeatures",
      "rel" : "enabledfeatures"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/externalnetworkproviders",
      "rel" : "externalnetworkproviders"
    } ]
  } ]
}

Copy to Clipboard

Toggle word wrap

Expand

表7.47 属性の概要
名前	型	Summary
`ballooning_enabled`	ブール値
`bios_type`	BiosType	チップセットと BIOS タイプの組み合わせ。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`cpu`	Cpu
`custom_scheduling_policy_properties`	Property[]	クラスターのカスタムスケジューリングポリシーのプロパティー。
`description`	String	プレーンテキストでの人間が判読できる説明。
`display`	表示
`error_handling`	ErrorHandling
`fencing_policy`	FencingPolicy	クラスターに対してカスタムフェンシングポリシーを定義できます。
`fips_mode`	FipsMode	クラスターの FIPS モード。
`firewall_type`	FirewallType	このクラスター内のホストで使用されるファイアウォールのタイプ。
`gluster_service`	ブール値
`gluster_tuned_profile`	String	調整済みプロファイルの名前。
`ha_reservation`	ブール値
`id`	String	一意の ID
`ksm`	Ksm
`log_max_memory_used_threshold`	Integer	監査ログイベントを記録するためのメモリー消費のしきい値。
`log_max_memory_used_threshold_type`	LogMaxMemoryUsedThresholdType	監査ログイベントをログに記録するためのメモリー消費しきい値のタイプ。
`maintenance_reason_required`	ブール値	このプロパティーは関連性がなくなり、非推奨になりました。
`memory_policy`	MemoryPolicy
`migration`	MigrationOptions	実行中の仮想マシンを別のホストに移行するためのクラスター全体の設定への参照。
`name`	String	人間が判読できるプレーンテキストでの名前。
`optional_reason`	ブール値	このプロパティーは関連性がなくなり、非推奨になりました。
`required_rng_sources`	RngSource[]	クラスター内の各ホストに必要な乱数ジェネレーター (RNG) ソースのセット。
`serial_number`	SerialNumber
`supported_versions`	Version[]
`switch_type`	SwitchType	指定されたクラスター内のすべてのネットワークで使用されるスイッチのタイプ。
`threads_as_cores`	ブール値
`trusted_service`	ブール値
`tunnel_migration`	ブール値
`upgrade_correlation_id`	String	アップグレード相関識別子。
`upgrade_in_progress`	ブール値	クラスターのアップグレードが開始されたかどうかを示します。
`upgrade_percent_complete`	Integer	アップグレードが進行中の場合、報告されたアップグレードの完了率。
`version`	バージョン	クラスターの互換バージョン。
`virt_service`	ブール値
`vnc_encryption`	ブール値	VNC 暗号化を有効にします。

7.35.1. bios_type
リンクのコピー

チップセットと BIOS タイプの組み合わせ。

この値は、biosType が CLUSTER_DEFAULT に設定されているクラスター内のすべての仮想マシンのデフォルトとして使用されます。

7.35.2. custom_scheduling_policy_properties
リンクのコピー

クラスターのカスタムスケジューリングポリシーのプロパティー。これらのオプションのプロパティーは、scheduling_policy リンクで指定されたスケジューリングポリシーのプロパティーをオーバーライドし、この特定のクラスターにのみ適用されます。

たとえば、クラスターのカスタムプロパティーを更新するには、以下のリクエストを送信します。

PUT /ovirt-engine/api/clusters/123

PUT /ovirt-engine/api/clusters/123

Copy to Clipboard

Toggle word wrap

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

<cluster>
  <custom_scheduling_policy_properties>
    <property>
      <name>HighUtilization</name>
      <value>70</value>
    </property>
  </custom_scheduling_policy_properties>
</cluster>

<cluster>
  <custom_scheduling_policy_properties>
    <property>
      <name>HighUtilization</name>
      <value>70</value>
    </property>
  </custom_scheduling_policy_properties>
</cluster>

Copy to Clipboard

Toggle word wrap

custom_scheduling_policy_properties 属性を使用した更新操作では、scheduling_policy リンクで指定されたスケジューリングポリシーのプロパティーは更新されず、この特定のクラスターにのみ反映されます。

7.35.3. fencing_policy
リンクのコピー

クラスターに対してカスタムフェンシングポリシーを定義できます。

以下に例を示します。

PUT /ovirt-engine/api/cluster/123

PUT /ovirt-engine/api/cluster/123

Copy to Clipboard

Toggle word wrap

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

<cluster>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
  </fencing_policy>
</cluster>

<cluster>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
  </fencing_policy>
</cluster>

Copy to Clipboard

Toggle word wrap

7.35.4. fips_mode
リンクのコピー

クラスターの FIPS モード。

FIPS モードは、ホストに対するクラスターのポリシーを表します。クラスターに追加されたホストは、クラスターの FIPS モードを満たしているかどうかがチェックされ、満たしていない場合は操作不能になります。値が明示的に指定されない限り、新しいクラスターはデフォルトで UNDEFINED に初期化されます。この値は、クラスターに追加された最初のホストの FIPS モードに自動的に変更されます。

7.35.5. gluster_tuned_profile
リンクのコピー

調整済みプロファイルの名前。

クラスター内のすべてのホストに設定するように調整されたプロファイル。これは必須ではなく、Gluster サービスを使用するクラスターにのみ関連します。

7.35.6. log_max_memory_used_threshold
リンクのコピー

監査ログイベントを記録するためのメモリー消費のしきい値。

パーセンテージの場合、使用メモリーが指定された値を超えると、監査ログイベントがログに記録されます。絶対値の場合、空きメモリーが MB で指定された値を下回ると、監査ログイベントがログに記録されます。

7.35.7. log_max_memory_used_threshold_type
リンクのコピー

監査ログイベントをログに記録するためのメモリー消費しきい値のタイプ。

'percentage' と 'absolute_value_in_mb' のいずれかを選択できます。

7.35.8. maintenance_reason_required
リンクのコピー

このプロパティーは関連性がなくなり、非推奨になりました。デフォルト値は true です。

7.35.9. migration
リンクのコピー

実行中の仮想マシンを別のホストに移行するためのクラスター全体の設定への参照。

注記

このメソッドが返す ID で移行ポリシーを照会する API はまだ実装されていません。/ovirt-engine/api/options/MigrationPolicies を使用して、すべての移行ポリシーとその ID のリストを取得します。

7.35.10. optional_reason
リンクのコピー

このプロパティーは関連性がなくなり、非推奨になりました。デフォルト値は true です。

7.35.11. required_rng_sources
リンクのコピー

クラスター内の各ホストに必要な乱数ジェネレーター (RNG) ソースのセット。

読み取られると、暗黙的な urandom (クラスターバージョン 4.1 以降の場合) または random (クラスターバージョン 4.0 以前の場合) に加えて、選択された RNG ソースが追加で返されます。書き込まれると、暗黙的な urandom と random RNG ソースは削除できません。

重要

エンジンのバージョン 4.1 より前では、必要な乱数ジェネレーターのセットは管理者によって完全に制御可能で、random ソースを含む任意のソースを追加または削除できます。しかし、バージョン 4.1 以降では、urandom と random ソースは常にセットの一部となり、削除することはできません。

重要

エンジンバージョン 4.1 では、クラスター内の random RNG ソースを互換バージョン 4.1 以降に置き換える新しい RNG ソース urandom が導入されています。

7.35.12. upgrade_correlation_id
リンクのコピー

アップグレード相関識別子。クラスターのアップグレードの詳細を示すイベントをアップグレード自体に関連付けるために使用します。

7.35.13. version
リンクのコピー

クラスターの互換バージョン。

このクラスター内のすべてのホストは、少なくともこの互換バージョンをサポートする必要があります。

以下に例を示します。

GET /ovirt-engine/api/clusters/123

GET /ovirt-engine/api/clusters/123

Copy to Clipboard

Toggle word wrap

次のように応答します。

<cluster>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</cluster>

<cluster>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</cluster>

Copy to Clipboard

Toggle word wrap

互換バージョンを更新するには、以下を使用します。

PUT /ovirt-engine/api/clusters/123

PUT /ovirt-engine/api/clusters/123

Copy to Clipboard

Toggle word wrap

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

<cluster>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</cluster>

<cluster>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</cluster>

Copy to Clipboard

Toggle word wrap

クラスター互換バージョンを更新するには、クラスター内のすべてのホストが新しい互換バージョンをサポートする必要があります。

7.35.14. vnc_encryption
リンクのコピー

VNC 暗号化を有効にします。このプロパティーのデフォルト値は false です。

Expand

表7.48 リンクの概要
名前	型	Summary
`affinity_groups`	AffinityGroup[]
`cpu_profiles`	CpuProfile[]
`data_center`	DataCenter
`enabled_features`	ClusterFeature[]	クラスターで有効になっているカスタム機能。
`external_network_providers`	ExternalProvider[]	クラスターで利用可能な外部ネットワークプロバイダーへの参照。
`gluster_hooks`	GlusterHook[]
`gluster_volumes`	GlusterVolume[]
`mac_pool`	MacPool	このクラスターによって使用される MAC プールへの参照。
`management_network`	Network
`network_filters`	NetworkFilter[]
`networks`	Network[]
`permissions`	Permission[]
`scheduling_policy`	SchedulingPolicy	このクラスターによって使用されるデフォルトのスケジューリングポリシーへの参照。

7.35.15. external_network_providers
リンクのコピー

クラスターで利用可能な外部ネットワークプロバイダーへの参照。

外部ネットワークプロバイダーの自動デプロイメントがサポートされる場合には、参照されるネットワークプロバイダーのネットワークはクラスター内のすべてのノードで利用可能になります。クラスターの外部ネットワークプロバイダーは、クラスターの追加時にのみ設定できます。この値はホストの追加時に個々のホストに対して上書きされる場合があります。

7.35.16. scheduling_policy
リンクのコピー

このクラスターによって使用されるデフォルトのスケジューリングポリシーへの参照。

注記

スケジューリングポリシープロパティーは、デフォルトで参照されるスケジューリングポリシーから取得されますが、このクラスターの custom_scheduling_policy_properties 属性で指定されたプロパティーで上書きされます。

7.36. ClusterFeature 構造体
リンクのコピー

タイプは、クラスターレベルで使用できる追加機能を表します。

Expand

表7.49 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.50 リンクの概要
名前	型	Summary
`cluster_level`	ClusterLevel	クラスターレベルへの参照。

7.37. ClusterLevel 構造体
リンクのコピー

特定のクラスターレベルでサポートされる機能を説明します。

Expand

表7.51 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`cpu_types`	CpuType[]	このクラスターレベルでサポートされている CPU タイプ。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`permits`	Permit[]	このクラスターレベルでサポートされている permits。

Expand

表7.52 リンクの概要
名前	型	Summary
`cluster_features`	ClusterFeature[]	このクラスターレベルでサポートされる追加機能。

7.38. ClusterUpgradeAction enum
リンクのコピー

クラスターアップグレードアクションのアクションタイプ。

Expand

表7.53 値の概要
名前	Summary
`finish`	クラスターの upgrade_running フラグを false にマークして、クラスターのアップグレードプロセスを完了するために渡されるアップグレードアクション。
`start`	クラスターの upgrade_running フラグを true にマークして、クラスターのアップグレードプロセスを開始するために渡されるアップグレードアクション。
`update_progress`	クラスターのアップグレードの進行状況を更新するために渡されるアップグレードアクション。

7.38.1. finish
リンクのコピー

クラスターの upgrade_running フラグを false にマークして、クラスターのアップグレードプロセスを完了するために渡されるアップグレードアクション。これは、クラスターのアップグレードプロセスの最後に使用する必要があります。

7.38.2. start
リンクのコピー

クラスターの upgrade_running フラグを true にマークして、クラスターのアップグレードプロセスを開始するために渡されるアップグレードアクション。これは、クラスターのアップグレードプロセスの開始時に使用する必要があります。

7.38.3. update_progress
リンクのコピー

クラスターのアップグレードの進行状況を更新するために渡されるアップグレードアクション。これは、アップグレードの進行に合わせて使用する必要があります。

7.39. Configuration 構造体
リンクのコピー

Expand

表7.54 属性の概要
名前	型	Summary
`data`	String	仮想マシンを記述するドキュメント。
`type`	ConfigurationType

7.39.1. data
リンクのコピー

仮想マシンを記述するドキュメント。

OVF ドキュメントの例:

<?xml version='1.0' encoding='UTF-8'?>
<ovf:Envelope xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1/"
  xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
  xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  ovf:version="3.5.0.0">
  <References/>
  <Section xsi:type="ovf:NetworkSection_Type">
    <Info>List of networks</Info>
    <Network ovf:name="Network 1"/>
  </Section>
  <Section xsi:type="ovf:DiskSection_Type">
    <Info>List of Virtual Disks</Info>
  </Section>
  <Content ovf:id="out" xsi:type="ovf:VirtualSystem_Type">
    <CreationDate>2014/12/03 04:25:45</CreationDate>
    <ExportDate>2015/02/09 14:12:24</ExportDate>
    <DeleteProtected>false</DeleteProtected>
    <SsoMethod>guest_agent</SsoMethod>
    <IsSmartcardEnabled>false</IsSmartcardEnabled>
    <TimeZone>Etc/GMT</TimeZone>
    <default_boot_sequence>0</default_boot_sequence>
    <Generation>1</Generation>
    <VmType>1</VmType>
    <MinAllocatedMem>1024</MinAllocatedMem>
    <IsStateless>false</IsStateless>
    <IsRunAndPause>false</IsRunAndPause>
    <AutoStartup>false</AutoStartup>
    <Priority>1</Priority>
    <CreatedByUserId>fdfc627c-d875-11e0-90f0-83df133b58cc</CreatedByUserId>
    <IsBootMenuEnabled>false</IsBootMenuEnabled>
    <IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled>
    <IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled>
    <Name>VM_export</Name>
    <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId>
    <TemplateName>Blank</TemplateName>
    <IsInitilized>false</IsInitilized>
    <Origin>3</Origin>
    <DefaultDisplayType>1</DefaultDisplayType>
    <TrustedService>false</TrustedService>
    <OriginalTemplateId>00000000-0000-0000-0000-000000000000</OriginalTemplateId>
    <OriginalTemplateName>Blank</OriginalTemplateName>
    <UseLatestVersion>false</UseLatestVersion>
    <Section ovf:id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a"
      ovf:required="false"
      xsi:type="ovf:OperatingSystemSection_Type">
      <Info>Guest Operating System</Info>
      <Description>other</Description>
    </Section>
    <Section xsi:type="ovf:VirtualHardwareSection_Type">
      <Info>1 CPU, 1024 Memory</Info>
      <System>
        <vssd:VirtualSystemType>ENGINE 3.5.0.0</vssd:VirtualSystemType>
      </System>
      <Item>
        <rasd:Caption>1 virtual cpu</rasd:Caption>
        <rasd:Description>Number of virtual CPU</rasd:Description>
        <rasd:InstanceId>1</rasd:InstanceId>
        <rasd:ResourceType>3</rasd:ResourceType>
        <rasd:num_of_sockets>1</rasd:num_of_sockets>
        <rasd:cpu_per_socket>1</rasd:cpu_per_socket>
      </Item>
      <Item>
        <rasd:Caption>1024 MB of memory</rasd:Caption>
        <rasd:Description>Memory Size</rasd:Description>
        <rasd:InstanceId>2</rasd:InstanceId>
        <rasd:ResourceType>4</rasd:ResourceType>
        <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
        <rasd:VirtualQuantity>1024</rasd:VirtualQuantity>
      </Item>
      <Item>
        <rasd:Caption>USB Controller</rasd:Caption>
        <rasd:InstanceId>3</rasd:InstanceId>
        <rasd:ResourceType>23</rasd:ResourceType>
        <rasd:UsbPolicy>DISABLED</rasd:UsbPolicy>
      </Item>
    </Section>
  </Content>
</ovf:Envelope>

<?xml version='1.0' encoding='UTF-8'?>
<ovf:Envelope xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1/"
  xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
  xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  ovf:version="3.5.0.0">
  <References/>
  <Section xsi:type="ovf:NetworkSection_Type">
    <Info>List of networks</Info>
    <Network ovf:name="Network 1"/>
  </Section>
  <Section xsi:type="ovf:DiskSection_Type">
    <Info>List of Virtual Disks</Info>
  </Section>
  <Content ovf:id="out" xsi:type="ovf:VirtualSystem_Type">
    <CreationDate>2014/12/03 04:25:45</CreationDate>
    <ExportDate>2015/02/09 14:12:24</ExportDate>
    <DeleteProtected>false</DeleteProtected>
    <SsoMethod>guest_agent</SsoMethod>
    <IsSmartcardEnabled>false</IsSmartcardEnabled>
    <TimeZone>Etc/GMT</TimeZone>
    <default_boot_sequence>0</default_boot_sequence>
    <Generation>1</Generation>
    <VmType>1</VmType>
    <MinAllocatedMem>1024</MinAllocatedMem>
    <IsStateless>false</IsStateless>
    <IsRunAndPause>false</IsRunAndPause>
    <AutoStartup>false</AutoStartup>
    <Priority>1</Priority>
    <CreatedByUserId>fdfc627c-d875-11e0-90f0-83df133b58cc</CreatedByUserId>
    <IsBootMenuEnabled>false</IsBootMenuEnabled>
    <IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled>
    <IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled>
    <Name>VM_export</Name>
    <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId>
    <TemplateName>Blank</TemplateName>
    <IsInitilized>false</IsInitilized>
    <Origin>3</Origin>
    <DefaultDisplayType>1</DefaultDisplayType>
    <TrustedService>false</TrustedService>
    <OriginalTemplateId>00000000-0000-0000-0000-000000000000</OriginalTemplateId>
    <OriginalTemplateName>Blank</OriginalTemplateName>
    <UseLatestVersion>false</UseLatestVersion>
    <Section ovf:id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a"
      ovf:required="false"
      xsi:type="ovf:OperatingSystemSection_Type">
      <Info>Guest Operating System</Info>
      <Description>other</Description>
    </Section>
    <Section xsi:type="ovf:VirtualHardwareSection_Type">
      <Info>1 CPU, 1024 Memory</Info>
      <System>
        <vssd:VirtualSystemType>ENGINE 3.5.0.0</vssd:VirtualSystemType>
      </System>
      <Item>
        <rasd:Caption>1 virtual cpu</rasd:Caption>
        <rasd:Description>Number of virtual CPU</rasd:Description>
        <rasd:InstanceId>1</rasd:InstanceId>
        <rasd:ResourceType>3</rasd:ResourceType>
        <rasd:num_of_sockets>1</rasd:num_of_sockets>
        <rasd:cpu_per_socket>1</rasd:cpu_per_socket>
      </Item>
      <Item>
        <rasd:Caption>1024 MB of memory</rasd:Caption>
        <rasd:Description>Memory Size</rasd:Description>
        <rasd:InstanceId>2</rasd:InstanceId>
        <rasd:ResourceType>4</rasd:ResourceType>
        <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
        <rasd:VirtualQuantity>1024</rasd:VirtualQuantity>
      </Item>
      <Item>
        <rasd:Caption>USB Controller</rasd:Caption>
        <rasd:InstanceId>3</rasd:InstanceId>
        <rasd:ResourceType>23</rasd:ResourceType>
        <rasd:UsbPolicy>DISABLED</rasd:UsbPolicy>
      </Item>
    </Section>
  </Content>
</ovf:Envelope>

Copy to Clipboard

Toggle word wrap

7.40. ConfigurationType enum
リンクのコピー

設定フォーマットのタイプ。

Expand

表7.55 値の概要
名前	Summary
`ova`	標準 OVF タイプの ConfigurationType。
`ovf`	oVirt 互換 OVF タイプの ConfigurationType。

7.40.1. ova
リンクのコピー

標準 OVF タイプの ConfigurationType。

提供される仮想マシン設定は、Open Virtualization Format (OVF) 標準に準拠しています。この値は、oVirt または他のベンダーによって生成された Open Virtual Appliance (OVA) から抽出された OVF 設定に使用する必要があります。OVF 仕様を参照してください。

7.40.2. ovf
リンクのコピー

oVirt 互換 OVF タイプの ConfigurationType。

提供される仮想マシン設定は、Open Virtualization Format (OVF) の oVirt 互換形式に準拠しています。OVF の oVirt 互換形式は、他のベンダーが使用する OVF 標準とは異なる場合があることに注意してください。この値は、ストレージドメインから取得される OVF 設定に使用する必要があります。

7.41. Console 構造体
リンクのコピー

シリアルコンソールデバイスの表現。

Expand

表7.56 属性の概要
名前	型	Summary
`enabled`	ブール値	シリアルコンソールデバイスを有効/無効にします。

7.42. Core 構造体
リンクのコピー

Expand

表7.57 属性の概要
名前	型	Summary
`index`	Integer
`socket`	Integer

7.43. CPU 構造体
リンクのコピー

Expand

表7.58 属性の概要
名前	型	Summary
`architecture`	アーキテクチャー
`cores`	Core[]
`cpu_tune`	CpuTune
`level`	Integer
`mode`	CpuMode
`name`	String
`speed`	10 進数
`topology`	CpuTopology
`type`	String

7.44. CpuMode enum
リンクのコピー

Expand

表7.59 値の概要
名前	Summary
`custom`
`host_model`
`host_passthrough`

7.45. CpuPinningPolicy enum
リンクのコピー

CPU および NUMA ピニングポリシーを表すタイプ。

Expand

表7.60 値の概要
名前	Summary
`dedicated`	CPU ピニングは、仮想マシン起動時にエンジンによって自動的に計算され、仮想マシン停止時に削除されます。
`isolate_threads`	CPU ピニングは、仮想マシン起動時にエンジンによって自動的に計算され、仮想マシン停止時に削除されます。
`manual`	CPU ピニングは手動で設定されます。
`none`	CPU ピニングは設定されません。
`resize_and_pin_numa`	CPU と NUMA ピニングは、専用ホストによって設定されます。

7.45.1. dedicated
リンクのコピー

CPU ピニングは、仮想マシン起動時にエンジンによって自動的に計算され、仮想マシン停止時に削除されます。

ピニングは排他的です。つまり、他の仮想マシンはピニングされた物理 CPU を使用できません。

7.45.2. isolate_threads
リンクのコピー

CPU ピニングは、仮想マシン起動時にエンジンによって自動的に計算され、仮想マシン停止時に削除されます。

ピニングは排他的で、各仮想スレッドは排他的な物理コアを取得します。これは、ピニングされた物理 CPU を他の仮想マシンが使用できないことを意味します。

7.45.3. manual
リンクのコピー

CPU ピニングは手動で設定されます。

これは、現時点で CPU ピニングが現在の仮想マシン設定に対して手動で設定されることを意味します。仮想マシンは、少なくとも 1 つのホストにピニングされる必要があります。ピニングは、CpuTune を使用して、CPU 設定内で提供されます。

7.45.4. none
リンクのコピー

CPU ピニングは設定されません。

これは、現時点で CPU ピニングが現在の仮想マシン設定に対して設定されないことを意味します。デフォルトでは、仮想マシントポロジーは 1 ソケット、1 コア、および 1 スレッドに設定されます。

7.45.5. resize_and_pin_numa
リンクのコピー

CPU と NUMA ピニングは、専用ホストによって設定されます。

CPU と NUMA ピニングでは、専用のホスト CPU トポロジーが使用されます。仮想マシンの設定は、可能な限り最高のパフォーマンスが得られるように、ホストに合わせて自動的に設定されます。

7.46. CpuProfile 構造体
リンクのコピー

Expand

表7.61 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.62 リンクの概要
名前	型	Summary
`cluster`	クラスター
`permissions`	Permission[]
`qos`	Qos

7.47. CpuTopology 構造体
リンクのコピー

Expand

表7.63 属性の概要
名前	型	Summary
`cores`	Integer
`sockets`	Integer
`threads`	Integer

7.48. CpuTune 構造体
リンクのコピー

Expand

表7.64 属性の概要
名前	型	Summary
`vcpu_pins`	VcpuPin[]

7.49. CpuType 構造体
リンクのコピー

サポートされている CPU タイプを記述します。

Expand

表7.65 属性の概要
名前	型	Summary
`architecture`	アーキテクチャー	CPU のアーキテクチャー。
`level`	Integer	CPU タイプのレベル。
`name`	String	CPU タイプの名前 (例: `Intel Nehalem Family`)。

7.50. CreationStatus enum
リンクのコピー

Expand

表7.66 値の概要
名前	Summary
`完了`
`failed`
`in_progress`
`pending`

7.51. CustomProperty 構造体
リンクのコピー

カスタムプロパティーの表現。

Expand

表7.67 属性の概要
名前	型	Summary
`name`	String	プロパティー名
`regexp`	String	カスタムプロパティーが取得できる使用可能な値を定義する正規表現。
`value`	String	プロパティーの値。

7.52. DataCenter 構造体
リンクのコピー

Expand

表7.68 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`local`	ブール値
`name`	String	人間が判読できるプレーンテキストでの名前。
`quota_mode`	QuotaModeType
`status`	DataCenterStatus
`storage_format`	StorageFormat
`supported_versions`	Version[]
`version`	バージョン	データセンターの互換バージョン。

7.52.1. version
リンクのコピー

データセンターの互換バージョン。

このデータセンター内のすべてのクラスターは、少なくともこの互換バージョンに設定されている必要があります。

以下に例を示します。

GET /ovirt-engine/api/datacenters/123

GET /ovirt-engine/api/datacenters/123

Copy to Clipboard

Toggle word wrap

以下を応答します。

<data_center>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</data_center>

<data_center>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</data_center>

Copy to Clipboard

Toggle word wrap

互換バージョンを更新するには、以下を使用します。

PUT /ovirt-engine/api/datacenters/123

PUT /ovirt-engine/api/datacenters/123

Copy to Clipboard

Toggle word wrap

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

<data_center>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</data_center>

<data_center>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</data_center>

Copy to Clipboard

Toggle word wrap

Expand

表7.69 リンクの概要
名前	型	Summary
`clusters`	Cluster[]	このデータセンター内のクラスターへの参照。
`iscsi_bonds`	IscsiBond[]	このデータセンターによって使用される ISCSI ボンディングへの参照。
`mac_pool`	MacPool	このデータセンターによって使用される MAC プールへの参照。
`networks`	Network[]	このデータセンターに接続されたネットワークへの参照。
`permissions`	Permission[]	このデータセンターに割り当てられたパーミッションへの参照。
`qoss`	Qos[]	このデータセンターが使用する QoS への参照。
`quotas`	Quota[]	このデータセンターに割り当てられたクォータへの参照。
`storage_domains`	StorageDomain[]	このデータセンターに割り当てられたストレージドメインへの参照。

7.53. DataCenterStatus enum
リンクのコピー

Expand

表7.70 値の概要
名前	Summary
`contend`
`maintenance`
`not_operational`
`problematic`
`uninitialized`
`up`

7.54. Device 構造体
リンクのコピー

デバイスは、デバイスの潜在的な親へのリンクをラップします。

Expand

表7.71 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.72 リンクの概要
名前	型	Summary
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.54.1. vms
リンクのコピー

7.55. Disk 構造体
リンクのコピー

仮想ディスクデバイスを表します。

Expand

表7.73 属性の概要
名前	型	Summary
`active`	ブール値	ディスクが仮想マシンから見えるかどうかを示します。
`actual_size`	Integer	ディスクの実際のサイズ (バイト単位)。
`alias`	String
`backup`	DiskBackup	ディスクでサポートされているバックアップ動作。
`backup_mode`	DiskBackupMode	ディスクバックアップのタイプ (完全/増分)。ディスクバックアップが進行中の場合にのみ表示されます。
`bootable`	ブール値	ディスクが起動可能としてマークされているかどうかを示します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`content_type`	DiskContentType	ディスク上に存在する実際のコンテンツを示します。
`description`	String	プレーンテキストでの人間が判読できる説明。
`external_disk`	String	外部ディスクを使用します。
`format`	DiskFormat	基礎となるストレージフォーマット。
`id`	String	一意の ID
`image_id`	String
`initial_size`	Integer	ブロックストレージで作成された sparse イメージディスクの初期サイズ (バイト単位)。
`interface`	DiskInterface	ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。
`logical_name`	String
`lun_storage`	HostStorage
`name`	String	人間が判読できるプレーンテキストでの名前。
`propagate_errors`	ブール値	ディスクエラーが原因で仮想マシンを一時停止する必要があるかどうか、または代わりにディスクエラーをゲストオペレーティングシステムに伝播する必要があるかどうかを示します。
`provisioned_size`	Integer	ディスクの仮想サイズ (バイト単位)。
`qcow_version`	QcowVersion	QCOW ボリュームの基礎となる QCOW バージョン。
`read_only`	ブール値	ディスクが読み取り専用モードかどうかを示します。
`sgio`	ScsiGenericIO	SCSI パススルーが有効かどうか、およびそのポリシーを示します。
`shareable`	ブール値	ディスクを複数の仮想マシンに接続できるかどうかを示します。
`sparse`	ブール値	ディスクの物理ストレージの事前割り当てを避けるべきかどうかを示します。
`status`	DiskStatus	ディスクデバイスのステータス。
`storage_type`	DiskStorageType
`total_size`	Integer	すべてのスナップショットを含むディスクの合計サイズ (バイト単位)。
`uses_scsi_reservation`	ブール値
`wipe_after_delete`	ブール値	削除後にディスクのブロックがゼロとして読み戻されるかどうかを示します。 - ブロックストレージでは、ディスクはゼロにならなければ削除できません。

7.55.1. active
リンクのコピー

ディスクが仮想マシンから見えるかどうかを示します。

重要

仮想マシンにディスクアタッチメントを追加するときに、サーバーがこの属性を含まない要求を受け入れる場合、未定義となります。場合によっては、ディスクが自動的にアクティベートされ、それ以外の場合は自動的にアクティブになりません。問題を回避するには、常に希望の値でこの属性をふくめることを強く推奨します。

7.55.2. actual_size
リンクのコピー

ディスクの実際のサイズ (バイト単位)。

実際のサイズは、ディスクが実際に使用するバイト数です。cow フォーマットを使用するディスクのプロビジョニングされたサイズよりも小さくなります。

7.55.3. bootable
リンクのコピー

ディスクが起動可能としてマークされているかどうかを示します。

重要

この属性は、実際に仮想マシンに接続されているディスクに対してのみ意味があり、API のバージョン 4 では、DiskAttachment タイプに移動されています。ここでは後方互換性のためにのみ保持されており、将来的には削除される予定です。

7.55.4. external_disk
リンクのコピー

外部ディスクを使用します。

外部ディスクは、次のように、ローカルファイルまたはブロックデバイスへのパス、または QEMU でサポートされている URL にできます。

nbd:<host>:<port>[:exportname=<export>]
nbd:unix:</path>[:exportname=<export>]
http://[<username>[:<password>]@]<host>/<path>
https://[<username>[:<password>]@]<host>/<path>
ftp://[<username>[:<password>]@]<host>/<path>
ftps://[<username>[:<password>]@]<host>/<path>

サポートされるプロトコルおよび詳細情報は、QEMU のマニュアルを参照してください。

7.55.5. initial_size
リンクのコピー

ブロックストレージで作成された sparse イメージディスクの初期サイズ (バイト単位)。

初期サイズは、sparse ディスクがブロックストレージ上に作成されたときに最初に割り当てられるバイト数です。初期サイズは、プロビジョニングされたサイズよりも小さくなります。指定されていない場合は、システムで使用されるデフォルトの初期サイズが割り当てられます。

7.55.6. interface
リンクのコピー

ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。

重要

7.55.7. provisioned_size
リンクのコピー

ディスクの仮想サイズ (バイト単位)。

新しいディスクを作成する場合、この属性は必須です。

7.55.8. qcow_version
リンクのコピー

QCOW ボリュームの基礎となる QCOW バージョン。QCOW バージョンは、ボリュームがサポートする qemu バージョンを qemu に指定します。このフィールドは update API を使用して更新でき、QCOW ボリュームについてのみ報告されます。これは、ディスクが作成されたストレージドメインのバージョンによって決まります。V4 より前のバージョンのストレージドメインは、QCOW2 ボリュームをサポートします。V4 ストレージドメインは QCOW2v3 もサポートします。異なる QCOW バージョンの機能の詳細は、QCOW3 を参照してください。

7.55.9. read_only
リンクのコピー

ディスクが読み取り専用モードかどうかを示します。

バージョン 4.0 以降では、この属性は API に表示されず、DiskAttachment に移動されました。

Red Hat Virtualization Manager のバージョン 4.1.2 以降、この属性は非推奨となり、将来的に削除される予定です。読み取り専用モードでディスクをアタッチするには、DiskAttachment タイプの read_only 属性を使用します。以下に例を示します。

POST /ovirt-engine/api/vms/123/diskattachments

POST /ovirt-engine/api/vms/123/diskattachments

Copy to Clipboard

Toggle word wrap

<disk_attachment>
  <read_only>true</read_only>
  ...
</disk_attachment>

<disk_attachment>
  <read_only>true</read_only>
  ...
</disk_attachment>

Copy to Clipboard

Toggle word wrap

7.55.10. sgio
リンクのコピー

SCSI パススルーが有効かどうか、およびそのポリシーを示します。

filtered/unfiltered の値を設定すると、非特権/特権 SCSI I/O を備えた LUN ディスクの SCSI パススルーが有効になります。SCSI パススルーを無効にするには、値を disabled に設定する必要があります

7.55.11. shareable
リンクのコピー

ディスクを複数の仮想マシンに接続できるかどうかを示します。

重要

ディスクが複数の仮想マシンに接続されている場合、たとえば GlusterFS や GFS などの共有ファイルシステムを使用して、データの破損を回避するためにディスクへのアクセスを調整するのは、接続された仮想マシンのゲストオペレーティングシステムのロールです。

7.55.12. total_size
リンクのコピー

すべてのスナップショットを含むディスクの合計サイズ (バイト単位)。

合計サイズは、ディスクによって実際に使用されたバイト数にスナップショットのサイズを加えたものです。ダイレクト LUN および Cinder ディスクには設定されません。スナップショットのないディスクの場合、合計サイズは実際のサイズと同じです。

7.55.13. wipe_after_delete
リンクのコピー

削除後にディスクのブロックがゼロとして読み戻されるかどうかを示します。

ブロックストレージでは、ディスクはゼロにならなければ削除できません。
ファイルストレージでは、以前に削除されたブロックがゼロとして読み戻されることがファイルシステムによってすでに保証されているため、ディスクはすぐに削除されます。

Expand

表7.74 リンクの概要
名前	型	Summary
`disk_profile`	DiskProfile
`disk_snapshots`	DiskSnapshot[]
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`openstack_volume_type`	OpenStackVolumeType
`permissions`	Permission[]
`quota`	クォータ
`snapshot`	スナップショット
`statistics`	Statistic[]	ディスクによって公開される統計。
`storage_domain`	StorageDomain
`storage_domains`	StorageDomain[]	このディスクに関連付けられているストレージドメイン。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.55.14. statistics
リンクのコピー

ディスクによって公開される統計。以下に例を示します。

<statistics>
  <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456">
    <name>data.current.read</name>
    <description>Read data rate</description>
    <kind>gauge</kind>
    <type>decimal</type>
    <unit>bytes_per_second</unit>
    <values>
      <value>
        <datum>1052</datum>
      </value>
    </values>
    <disk href="/ovirt-engine/api/disks/123" id="123"/>
  </statistic>
  ...
</statistics>

<statistics>
  <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456">
    <name>data.current.read</name>
    <description>Read data rate</description>
    <kind>gauge</kind>
    <type>decimal</type>
    <unit>bytes_per_second</unit>
    <values>
      <value>
        <datum>1052</datum>
      </value>
    </values>
    <disk href="/ovirt-engine/api/disks/123" id="123"/>
  </statistic>
  ...
</statistics>

Copy to Clipboard

Toggle word wrap

ディスク取得時において、これらの統計は直接含まれず、リンクのみが含まれます。統計を取得するには、含まれているリンクに従ってください。

GET /ovirt-engine/api/disks/123/statistics

GET /ovirt-engine/api/disks/123/statistics

Copy to Clipboard

Toggle word wrap

7.55.15. storage_domains
リンクのコピー

このディスクに関連付けられているストレージドメイン。

注記

テンプレートから作成されたのではない仮想マシンに最初のディスクを追加する場合にのみ必要です。

7.55.16. vms
リンクのコピー

7.56. DiskAttachment 構造体
リンクのコピー

ディスクを仮想マシンに接続する方法について記述します。

Expand

表7.75 属性の概要
名前	型	Summary
`active`	ブール値	ディスクが接続されている仮想マシンでディスクがアクティブかどうかを定義します。
`bootable`	ブール値	ディスクが起動可能かどうかを定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`interface`	DiskInterface	ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。
`logical_name`	String	仮想マシンの内部から見た、仮想マシンのディスクの論理名。
`name`	String	人間が判読できるプレーンテキストでの名前。
`pass_discard`	ブール値	仮想マシンが破棄コマンドをストレージに渡すかどうかを定義します。
`read_only`	ブール値	ディスクが読み取り専用として仮想マシンに接続されているかどうかを示します。
`uses_scsi_reservation`	ブール値	このディスクに対して SCSI 予約を有効にするかどうかを定義します。

7.56.1. active
リンクのコピー

ディスクが接続されている仮想マシンでディスクがアクティブかどうかを定義します。

アクティブステータスの仮想マシンにアタッチされているディスクは、実行時に仮想マシンに接続され、使用することができます。

7.56.2. logical_name
リンクのコピー

仮想マシンの内部から見た、仮想マシンのディスクの論理名。

ディスクの論理名は、ゲストエージェントが仮想マシン内にインストールされて実行されている場合にのみ報告されます。

たとえば、ゲストオペレーティングシステムが Linux で、ディスクが VirtIO インターフェイスを介して接続されている場合、論理名は /dev/vda として報告されます。

<disk_attachment>
  ...
  <logical_name>/dev/vda</logical_name>
</disk_attachment>

<disk_attachment>
  ...
  <logical_name>/dev/vda</logical_name>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

ゲストゲストオペレーティングシステムが Windows の場合、論理名は \\.\PHYSICALDRIVE0 として報告されます。

7.56.3. read_only
リンクのコピー

ディスクが読み取り専用として仮想マシンに接続されているかどうかを示します。

新しいディスクアタッチメントを追加する場合、デフォルト値は false です。

<disk_attachment>
  ...
  <read_only>true</read_only>
</disk_attachment>

<disk_attachment>
  ...
  <read_only>true</read_only>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

7.56.4. uses_scsi_reservation
リンクのコピー

このディスクに対して SCSI 予約を有効にするかどうかを定義します。

VIRTIO-SCSI パススルーが有効になっている仮想マシンは、ディスクに永続的な SCSI 予約を設定できます。永続的な SCSI 予約を設定すると、それらの仮想マシンを別のホストに移行できなくなります。これは、SCSI 予約が SCSI イニシエーター、つまりホストに固有であるため、ディスクへのアクセスが失われるからです。このシナリオは自動的に検出できません。これらの仮想マシンが移行されないようにするために、ユーザーはこの属性を true に設定して、仮想マシンが SCSI 予約を使用していることを示すことができます。

Expand

表7.76 リンクの概要
名前	型	Summary
`disk`	ディスク	ディスクへの参照。
`template`	テンプレート	テンプレートへの参照。
`vm`	Vm	仮想マシンへの参照。

7.57. DiskBackup enum
リンクのコピー

ディスクで有効になっているバックアップメカニズムの列挙を表します。

Expand

表7.77 値の概要
名前	Summary
`incremental`	増分バックアップのサポート。
`none`	バックアップのサポートなし。

7.58. DiskBackupMode enum
リンクのコピー

バックアップモードの列挙を表します

Expand

表7.78 値の概要
名前	Summary
`full`	このディスクはフルバックアップをサポートしています。
`incremental`	このディスクは増分バックアップをサポートしています。

7.58.1. full
リンクのコピー

このディスクはフルバックアップをサポートしています。ゼロエクステントをクエリーして、すべてのディスクデータをダウンロードできます。

7.58.2. incremental
リンクのコピー

このディスクは増分バックアップをサポートしています。ダーティーエクステントをクエリーして、変更されたブロックをダウンロードできます。

7.59. DiskContentType enum
リンクのコピー

ディスク上にある実際のコンテンツ。

Expand

表7.79 値の概要
名前	Summary
`backup_scratch`	ディスクには、保護された VM バックアップデータが含まれています。
`data`	ディスクにはデータが含まれています。
`hosted_engine`	ディスクには、ホスト型エンジン VM ディスクが含まれています。
`hosted_engine_configuration`	ディスクには、Hosted Engine 設定ディスクが含まれています。
`hosted_engine_metadata`	ディスクには、Hosted Engine メタデータディスクが含まれています。
`hosted_engine_sanlock`	ディスクには、Hosted Engine Sanlock ディスクが含まれています。
`iso`	ディスクには、CDROM デバイスで使用される ISO イメージが含まれています。
`memory_dump_volume`	ディスクには、ライブスナップショットからのメモリーダンプが含まれています。
`memory_metadata_volume`	ディスクには、ライブスナップショットからのメモリーメタデータが含まれています。
`ovf_store`	ディスクは OVF ストアです。

7.60. DiskFormat enum
リンクのコピー

ディスクの基礎となるストレージフォーマット。

Expand

表7.80 値の概要
名前	Summary
`cow`	Copy On Write フォーマットでは、パフォーマンスのオーバーヘッドが小さいスナップショットが可能です。
`raw`	raw フォーマットではスナップショットは許可されませんが、パフォーマンスが向上します。

7.61. DiskInterface enum
リンクのコピー

コントローラーとのディスク通信の基盤となるストレージインターフェイス。

Expand

表7.81 値の概要
名前	Summary
`ide`	レガシーコントローラーデバイス。
`sata`	SATA コントローラーデバイス。
`spapr_vscsi`	SCSI プロトコルを使用して、IBM pSeries ファミリーのマシンでサポートされる準仮想化デバイス。
`virtio`	ゲストのデバイスドライバーだけが仮想環境で実行されていることを認識している仮想化インターフェイス。
`virtio_scsi`	準仮想化 SCSI コントローラーデバイス。

7.61.1. ide
リンクのコピー

レガシーコントローラーデバイス。ほぼすべてのゲストオペレーティングシステムで動作するため、互換性に優れています。パフォーマンスは、他の選択肢よりも低くなります。

7.61.2. virtio
リンクのコピー

ゲストのデバイスドライバーだけが仮想環境で実行されていることを認識している仮想化インターフェイス。ゲストが高性能のディスク操作を取得できるようにします。

7.61.3. virtio_scsi
リンクのコピー

準仮想化 SCSI コントローラーデバイス。SCSI プロトコルを使用して、ダイレクト物理ストレージデバイスアドレスを経由するゲストとの高速インターフェイス。

7.62. DiskProfile struct
リンクのコピー

Expand

表7.82 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.83 リンクの概要
名前	型	Summary
`permissions`	Permission[]
`qos`	Qos
`storage_domain`	StorageDomain

7.63. DiskSnapshot 構造体
リンクのコピー

Expand

表7.84 属性の概要
名前	型	Summary
`active`	ブール値	ディスクが仮想マシンから見えるかどうかを示します。
`actual_size`	Integer	ディスクの実際のサイズ (バイト単位)。
`alias`	String
`backup`	DiskBackup	ディスクでサポートされているバックアップ動作。
`backup_mode`	DiskBackupMode	ディスクバックアップのタイプ (完全/増分)。ディスクバックアップが進行中の場合にのみ表示されます。
`bootable`	ブール値	ディスクが起動可能としてマークされているかどうかを示します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`content_type`	DiskContentType	ディスク上に存在する実際のコンテンツを示します。
`description`	String	プレーンテキストでの人間が判読できる説明。
`external_disk`	String	外部ディスクを使用します。
`format`	DiskFormat	基礎となるストレージフォーマット。
`id`	String	一意の ID
`image_id`	String
`initial_size`	Integer	ブロックストレージで作成された sparse イメージディスクの初期サイズ (バイト単位)。
`interface`	DiskInterface	ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。
`logical_name`	String
`lun_storage`	HostStorage
`name`	String	人間が判読できるプレーンテキストでの名前。
`propagate_errors`	ブール値	ディスクエラーが原因で仮想マシンを一時停止する必要があるかどうか、または代わりにディスクエラーをゲストオペレーティングシステムに伝播する必要があるかどうかを示します。
`provisioned_size`	Integer	ディスクの仮想サイズ (バイト単位)。
`qcow_version`	QcowVersion	QCOW ボリュームの基礎となる QCOW バージョン。
`read_only`	ブール値	ディスクが読み取り専用モードかどうかを示します。
`sgio`	ScsiGenericIO	SCSI パススルーが有効かどうか、およびそのポリシーを示します。
`shareable`	ブール値	ディスクを複数の仮想マシンに接続できるかどうかを示します。
`sparse`	ブール値	ディスクの物理ストレージの事前割り当てを避けるべきかどうかを示します。
`status`	DiskStatus	ディスクデバイスのステータス。
`storage_type`	DiskStorageType
`total_size`	Integer	すべてのスナップショットを含むディスクの合計サイズ (バイト単位)。
`uses_scsi_reservation`	ブール値
`wipe_after_delete`	ブール値	削除後にディスクのブロックがゼロとして読み戻されるかどうかを示します。 - ブロックストレージでは、ディスクはゼロにならなければ削除できません。

7.63.1. active
リンクのコピー

ディスクが仮想マシンから見えるかどうかを示します。

重要

7.63.2. actual_size
リンクのコピー

ディスクの実際のサイズ (バイト単位)。

7.63.3. bootable
リンクのコピー

ディスクが起動可能としてマークされているかどうかを示します。

重要

7.63.4. external_disk
リンクのコピー

外部ディスクを使用します。

外部ディスクは、次のように、ローカルファイルまたはブロックデバイスへのパス、または QEMU でサポートされている URL にできます。

nbd:<host>:<port>[:exportname=<export>]
nbd:unix:</path>[:exportname=<export>]
http://[<username>[:<password>]@]<host>/<path>
https://[<username>[:<password>]@]<host>/<path>
ftp://[<username>[:<password>]@]<host>/<path>
ftps://[<username>[:<password>]@]<host>/<path>

サポートされるプロトコルおよび詳細情報は、QEMU のマニュアルを参照してください。

7.63.5. initial_size
リンクのコピー

ブロックストレージで作成された sparse イメージディスクの初期サイズ (バイト単位)。

7.63.6. interface
リンクのコピー

ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。

重要

7.63.7. provisioned_size
リンクのコピー

ディスクの仮想サイズ (バイト単位)。

新しいディスクを作成する場合、この属性は必須です。

7.63.8. qcow_version
リンクのコピー

7.63.9. read_only
リンクのコピー

ディスクが読み取り専用モードかどうかを示します。

バージョン 4.0 以降では、この属性は API に表示されず、DiskAttachment に移動されました。

POST /ovirt-engine/api/vms/123/diskattachments

POST /ovirt-engine/api/vms/123/diskattachments

Copy to Clipboard

Toggle word wrap

<disk_attachment>
  <read_only>true</read_only>
  ...
</disk_attachment>

<disk_attachment>
  <read_only>true</read_only>
  ...
</disk_attachment>

Copy to Clipboard

Toggle word wrap

7.63.10. sgio
リンクのコピー

SCSI パススルーが有効かどうか、およびそのポリシーを示します。

7.63.11. shareable
リンクのコピー

ディスクを複数の仮想マシンに接続できるかどうかを示します。

重要

7.63.12. total_size
リンクのコピー

すべてのスナップショットを含むディスクの合計サイズ (バイト単位)。

7.63.13. wipe_after_delete
リンクのコピー

削除後にディスクのブロックがゼロとして読み戻されるかどうかを示します。

ブロックストレージでは、ディスクはゼロにならなければ削除できません。
ファイルストレージでは、以前に削除されたブロックがゼロとして読み戻されることがファイルシステムによってすでに保証されているため、ディスクはすぐに削除されます。

Expand

表7.85 リンクの概要
名前	型	Summary
`disk`	ディスク
`disk_profile`	DiskProfile
`disk_snapshots`	DiskSnapshot[]
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`openstack_volume_type`	OpenStackVolumeType
`parent`	DiskSnapshot	親ディスクのスナップショット。
`permissions`	Permission[]
`quota`	クォータ
`snapshot`	スナップショット
`statistics`	Statistic[]	ディスクによって公開される統計。
`storage_domain`	StorageDomain
`storage_domains`	StorageDomain[]	このディスクに関連付けられているストレージドメイン。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.63.14. statistics
リンクのコピー

ディスクによって公開される統計。以下に例を示します。

<statistics>
  <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456">
    <name>data.current.read</name>
    <description>Read data rate</description>
    <kind>gauge</kind>
    <type>decimal</type>
    <unit>bytes_per_second</unit>
    <values>
      <value>
        <datum>1052</datum>
      </value>
    </values>
    <disk href="/ovirt-engine/api/disks/123" id="123"/>
  </statistic>
  ...
</statistics>

<statistics>
  <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456">
    <name>data.current.read</name>
    <description>Read data rate</description>
    <kind>gauge</kind>
    <type>decimal</type>
    <unit>bytes_per_second</unit>
    <values>
      <value>
        <datum>1052</datum>
      </value>
    </values>
    <disk href="/ovirt-engine/api/disks/123" id="123"/>
  </statistic>
  ...
</statistics>

Copy to Clipboard

Toggle word wrap

ディスク取得時において、これらの統計は直接含まれず、リンクのみが含まれます。統計を取得するには、含まれているリンクに従ってください。

GET /ovirt-engine/api/disks/123/statistics

GET /ovirt-engine/api/disks/123/statistics

Copy to Clipboard

Toggle word wrap

7.63.15. storage_domains
リンクのコピー

このディスクに関連付けられているストレージドメイン。

注記

テンプレートから作成されたのではない仮想マシンに最初のディスクを追加する場合にのみ必要です。

7.63.16. vms
リンクのコピー

7.64. DiskStatus enum
リンクのコピー

ディスクの現在のステータス表現。

Expand

表7.86 値の概要
名前	Summary
`illegal`	仮想マシンはディスクにアクセスできず、ユーザーは問題を解決するためのアクションを実行する必要があります。
`locked`	ディスクはシステムによって使用されているため、この時点では仮想マシンからアクセスできません。
`ok`	ディスクのステータスは正常で、仮想マシンからアクセスできます。

7.64.1. locked
リンクのコピー

ディスクはシステムによって使用されているため、この時点では仮想マシンからアクセスできません。これは通常、ディスクが解放されるまでの一時的なステータスです。

7.65. DiskStorageType enum
リンクのコピー

Expand

表7.87 値の概要
名前	Summary
`cinder`
`image`
`lun`
`managed_block_storage`	cinderlib ドライバーを使用して作成されたストレージドメインに使用されるストレージタイプ。

7.66. DiskType enum
リンクのコピー

Expand

表7.88 値の概要
名前	Summary
`data`
`system`

7.67. Display 構造体
リンクのコピー

グラフィックコンソール設定を表します。

Expand

表7.89 属性の概要
名前	型	Summary
`address`	String	グラフィックコンソールクライアントを接続するゲストの IP アドレス。
`allow_override`	ブール値	ホストごとに表示アドレスをオーバーライドするかどうかを示します。
`certificate`	証明書	TLS 接続の場合の TLS 証明書。
`copy_paste_enabled`	ブール値	ユーザーがコンテンツを外部ホストからグラフィックコンソールにコピーアンドペーストできるかどうかを示します。
`disconnect_action`	String	グラフィックコンソールが切断されたときに実行されるアクションを返します。
`disconnect_action_delay`	Integer	グラフィックコンソールの切断アクションが実行されるまでの遅延 (分単位)。
`file_transfer_enabled`	ブール値	ユーザーが外部ホストからグラフィックコンソールにファイルをドラッグアンドドロップできるかどうかを示します。
`keyboard_layout`	String	このグラフィックコンソールで使用するキーボードレイアウト。
`monitors`	Integer	このグラフィックコンソール用に開いているモニターの数。
`port`	Integer	グラフィックコンソールクライアントを接続するゲストのポートアドレス。
`proxy`	String	グラフィックコンソールクライアントがゲストに接続するために使用するプロキシー IP。
`secure_port`	Integer	TLS を使用する場合に、グラフィックコンソールクライアントを接続するための、ゲスト上の保護されたポートアドレス。
`single_qxl_pci`	ブール値	エンジンは、オペレーティングシステムに従って自動的に設定するようになりました。
`smartcard_enabled`	ブール値	スマートカード認証を使用するかどうかを示します。
`type`	DisplayType	グラフィックコンソールプロトコルのタイプ。

7.67.1. allow_override
リンクのコピー

ホストごとに表示アドレスをオーバーライドするかどうかを示します。Host.display 属性にのみ関連します。設定されている場合、仮想マシンのグラフィカルコンソールアドレスは、ホストで指定された表示アドレスによって上書きされます。設定されていない場合、仮想マシンのグラフィカルコンソールアドレスは上書きされません。

7.67.2. certificate
リンクのコピー

TLS 接続の場合の TLS 証明書。TLS が有効になっていない場合、報告されません。

7.67.3. copy_paste_enabled
リンクのコピー

ユーザーがコンテンツを外部ホストからグラフィックコンソールにコピーアンドペーストできるかどうかを示します。このオプションは、SPICE コンソールタイプでのみ使用できます。

7.67.4. disconnect_action
リンクのコピー

グラフィックコンソールが切断されたときに実行されるアクションを返します。オプションは次のとおりです。

none: アクションは実行されません。
lock_screen: 現在アクティブなユーザーセッションをロックします。
logout: 現在アクティブなユーザーセッションをログアウトします。
reboot: 仮想マシンの正常な再起動を開始します。
shutdown: 仮想マシンの正常なシャットダウンを開始します。

このオプションは、SPICE コンソールタイプでのみ使用できます。

7.67.5. disconnect_action_delay
リンクのコピー

グラフィックコンソールの切断アクションが実行されるまでの遅延 (分単位)。このオプションは、シャットダウン切断アクションでのみ使用できます。

7.67.6. file_transfer_enabled
リンクのコピー

ユーザーが外部ホストからグラフィックコンソールにファイルをドラッグアンドドロップできるかどうかを示します。このオプションは、SPICE コンソールタイプでのみ使用できます。

7.67.7. keyboard_layout
リンクのコピー

このグラフィックコンソールで使用するキーボードレイアウト。このオプションは、VNC コンソールタイプでのみ使用できます。キーボードが有効になっていない場合は報告されません。

7.67.8. monitors
リンクのコピー

このグラフィックコンソール用に開いているモニターの数。このオプションは、SPICE コンソールタイプでのみ使用できます。使用できる値は、1、2 または 4 です。

7.67.9. proxy
リンクのコピー

グラフィックコンソールクライアントがゲストに接続するために使用するプロキシー IP。クライアントがゲストのネットワークの外にある場合に便利です。このオプションは、SPICE コンソールタイプでのみ使用できます。このプロキシーは、グローバル設定、クラスターレベル、仮想マシンプールレベルで設定するか、仮想マシンごとに無効にすることができます。プロキシーが上記の場所のいずれかに設定されていて、仮想マシンに対して無効になっていない場合、このメソッドによって返されます。プロキシーが設定されていない場合、何も報告されません。

7.67.10. secure_port
リンクのコピー

TLS を使用する場合に、グラフィックコンソールクライアントを接続するための、ゲスト上の保護されたポートアドレス。TLS が有効になっていない場合、報告されません。

7.67.11. single_qxl_pci
リンクのコピー

エンジンは、オペレーティングシステムに従って自動的に設定するようになりました。そのため、4.4.5 から非推奨になりました。各モニターに 1 つの PCI スロットを使用するか、複数のモニターのすべてに単一の PCI チャネルを使用するかを示します。このオプションは、SPICE コンソールタイプでのみ使用でき、ゲスト Linux ベースの OS を接続する場合にのみ使用できます。

7.67.12. smartcard_enabled
リンクのコピー

スマートカード認証を使用するかどうかを示します。このオプションは、SPICE コンソールタイプでのみ使用できます。

7.68. DisplayType enum
リンクのコピー

仮想マシンのグラフィックコンソールへの接続に使用されるプロトコルの列挙を表します。

Expand

表7.90 値の概要
名前	Summary
`spice`	タイプ SPICE の表示。
`vnc`	タイプ VNC の表示。

7.68.1. spice
リンクのコピー

タイプ SPICE の表示。詳細は、SPICE のドキュメントを参照してください。

7.68.2. vnc
リンクのコピー

タイプ VNC の表示。VNC は Virtual Network Computing の略で、RFB (Remote Frame Buffer) プロトコルを使用して別のマシンをリモートで制御するグラフィカルデスクトップ共有システムです。

7.69. Dns 構造体
リンクのコピー

DNS リゾルバー設定を表します。

Expand

表7.91 属性の概要
名前	型	Summary
`search_domains`	Host[]	検索ドメインとして機能するホストの配列。
`servers`	Host[]	DNS サーバーとして機能するホストの配列。

7.70. DnsResolverConfiguration 構造体
リンクのコピー

DNS リゾルバー設定を表します。

Expand

表7.92 属性の概要
名前	型	Summary
`name_servers`	String[]	ネームサーバーのアドレスの配列。

7.70.1. name_servers
リンクのコピー

ネームサーバーのアドレスの配列。IPv4 または IPv6 アドレスのいずれかを指定できます。

7.71. Domain 構造体
リンクのコピー

このタイプは、ディレクトリーサービスドメインを表します。

Expand

表7.93 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`user`	User

Expand

表7.94 リンクの概要
名前	型	Summary
`グループ`	Group[]	ディレクトリーサービス内のすべてのグループへの参照。
`ユーザー`	User[]	ディレクトリーサービス内のすべてのユーザーリストへの参照。

7.71.1. ユーザー
リンクのコピー

ディレクトリーサービス内のすべてのユーザーリストへの参照。この情報は、新しいユーザーを Red Hat Virtualization 環境に追加するために使用されます。

7.72. DynamicCpu struct
リンクのコピー

仮想マシンの動的 CPU の設定。

Expand

表7.95 属性の概要
名前	型	Summary
`cpu_tune`	CpuTune
`topology`	CpuTopology

7.73. EntityExternalStatus enum
リンクのコピー

外部エンティティーのステータスを表すタイプ。

Expand

表7.96 値の概要
名前	Summary
`error`	外部エンティティーのステータスに誤りがあります。
`failure`	外部エンティティーに障害の原因となる問題があります。
`info`	外部エンティティーのステータスは問題ありませんが、関連する可能性のある情報がいくつかあります。
`ok`	外部エンティティーのステータスは問題ありません。
`warning`	外部エンティティーのステータスは問題ありませんが、注意が必要な問題があります。

7.73.1. error
リンクのコピー

外部エンティティーのステータスに誤りがあります。これには、適度な注意が必要な場合があります。

7.73.2. failure
リンクのコピー

外部エンティティーに障害の原因となる問題があります。すぐに注意が必要な場合があります。

7.74. EntityProfileDetail struct
リンクのコピー

Expand

表7.97 属性の概要
名前	型	Summary
`profile_details`	ProfileDetail[]

7.75. ErrorHandling 構造体
リンクのコピー

Expand

表7.98 属性の概要
名前	型	Summary
`on_error`	MigrateOnError

7.76. Event 構造体
リンクのコピー

イベントを表すタイプ。

Expand

表7.99 属性の概要
名前	型	Summary
`code`	Integer	イベントコード。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`correlation_id`	String	イベント相関識別子。
`custom_data`	String	カスタムイベントデータを表すフリーテキスト。
`custom_id`	Integer	カスタムイベント識別子。
`description`	String	プレーンテキストでの人間が判読できる説明。
`flood_rate`	Integer	フラッドレートを定義します。
`id`	String	一意の ID
`index`	Integer	このイベントの数値インデックス。
`log_on_host`	ブール値	イベントを ${hypervisor にも書き込むかどうかを指定します。
`name`	String	人間が判読できるプレーンテキストでの名前。
`origin`	String	イベントの発生源を特定するフリーテキスト。
`severity`	LogSeverity	イベントの重大度。
`time`	日付	イベント時間。

7.76.1. correlation_id
リンクのコピー

イベント相関識別子。複数のイベントを相互に関連付けるために使用されます。

7.76.2. flood_rate
リンクのコピー

フラッドレートを定義します。これにより、定義されたレートでイベントが複数回発生した場合のフラッディングが防止されます。デフォルトは 30 秒です。

7.76.3. index
リンクのコピー

このイベントの数値インデックス。イベントのインデックスは常に増加しているため、インデックスが高いイベントはインデックスが低いイベントよりも古いことが保証されます。

重要

エンジンの現在の実装では、id 属性はこの index 属性と同じ値を持ちます。これは、API ユーザーが依存すべきではない実装の詳細です。今後は、id 属性は、数字以外の文字を含み、暗黙的な順序を持たない任意の文字列に変更される可能性があります。一方、この index 属性は、今後も整数のままで順序付けされることが保証されています。

7.76.4. log_on_host
リンクのコピー

イベントを ${hypervisor.name} ログにも書き込むかどうかを指定します。ホストが指定されていない場合、イベントの説明はすべてのホストに書き込まれます。デフォルトは false です。

Expand

表7.100 リンクの概要
名前	型	Summary
`cluster`	クラスター	クラスターサービスへの参照。
`data_center`	DataCenter	データセンターサービスへの参照。
`host`	ホスト	ホストサービスへの参照。
`storage_domain`	StorageDomain	ストレージドメインサービスへの参照。
`template`	テンプレート	テンプレートサービスへの参照。
`user`	User	ユーザーサービスへの参照。
`vm`	Vm	仮想マシンサービスへの参照。

7.76.5. cluster
リンクのコピー

クラスターサービスへの参照。イベントはクラスターに関連付けることができます。

7.76.6. data_center
リンクのコピー

データセンターサービスへの参照。イベントはデータセンターに関連付けることができます。

7.76.7. host
リンクのコピー

ホストサービスへの参照。イベントはホストに関連付けることができます。

7.76.8. storage_domain
リンクのコピー

ストレージドメインサービスへの参照。イベントは、ストレージドメインに関連付けることができます。

7.76.9. template
リンクのコピー

テンプレートサービスへの参照。イベントはテンプレートに関連付けることができます。

7.76.10. user
リンクのコピー

ユーザーサービスへの参照。イベントはユーザーに関連付けることができます。

7.76.11. vm
リンクのコピー

仮想マシンサービスへの参照。イベントは仮想マシンに関連付けることができます。

7.77. EventSubscription 構造体
リンクのコピー

Expand

表7.101 属性の概要
名前	型	Summary
`address`	String	通知の送信先の電子メールアドレス。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`event`	NotifiableEvent	subscribed-for イベント。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`notification_method`	NotificationMethod	通知方法: SMTP または SNMP。
`user`	User	サブスクライブしているユーザー。

7.77.1. address
リンクのコピー

通知の送信先の電子メールアドレス。

指定しない場合、通知はユーザーの電子メールに送信されます。現時点では、ユーザーごとに 1 つのアドレスのみがサポートされます。既存のサブスクリプションとは異なる電子メールアドレスを持つサブスクリプションが追加された場合、提供されたアドレスがこのユーザーのイベントサブスクリプションの既存アドレスと競合するという説明と共に 409 (CONFLICT) ステータスが返されます。

今後このフィールドは非推奨になる止される可能性があり、通知は常にユーザーの電子メールアドレスに送信されます。

7.77.2. event
リンクのコピー

subscribed-for イベント。

(ユーザーと組み合わせ、イベントサブスクリプションを一意に識別します)。

7.77.3. notification_method
リンクのコピー

通知方法: SMTP または SNMP。

現在 API でサポートされているのは SMTP のみです。SNMP のサポートは、今後追加される予定です。

7.77.4. user
リンクのコピー

サブスクライブしているユーザー。

イベント名と組み合わせて、イベントサブスクリプションを一意に識別します。

7.78. ExternalComputeResource struct
リンクのコピー

Expand

表7.102 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`provider`	String
`url`	String
`user`	String

Expand

表7.103 リンクの概要
名前	型	Summary
`external_host_provider`	ExternalHostProvider

7.79. ExternalDiscoveredHost struct
リンクのコピー

Expand

表7.104 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`ip`	String
`last_report`	String
`mac`	String
`name`	String	人間が判読できるプレーンテキストでの名前。
`subnet_name`	String

Expand

表7.105 リンクの概要
名前	型	Summary
`external_host_provider`	ExternalHostProvider

7.80. ExternalHost 構造体
リンクのコピー

ホストプロバイダー (Foreman/Satellite など) によってプロビジョニングされたホストを表します。

詳細は、Foreman のドキュメントを参照してください。Red Hat Satellite の詳細は、Satellite のドキュメントを参照してください。

Expand

表7.106 属性の概要
名前	型	Summary
`address`	String	ホストのアドレスか、FQDN (完全修飾ドメイン名) の IP アドレス。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.107 リンクの概要
名前	型	Summary
`external_host_provider`	ExternalHostProvider	ホストの管理に使用する外部ホストプロバイダーへの参照。

7.81. ExternalHostGroup struct
リンクのコピー

Expand

表7.108 属性の概要
名前	型	Summary
`architecture_name`	String
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`domain_name`	String
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`operating_system_name`	String
`subnet_name`	String

Expand

表7.109 リンクの概要
名前	型	Summary
`external_host_provider`	ExternalHostProvider

7.82. ExternalHostProvider struct
リンクのコピー

Foreman や Satellite などの外部ホストのプロバイダーを表します。

詳細は、Foreman のドキュメントを参照してください。Red Hat Satellite の詳細は、Satellite のドキュメントを参照してください。

Expand

表7.110 属性の概要
名前	型	Summary
`authentication_url`	String	外部プロバイダー認証 URL アドレスを定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`password`	String	認証プロセス中にユーザーのパスワードを定義します。
`properties`	Property[]	プロバイダー名/値のプロパティーの配列。
`requires_authentication`	ブール値	プロバイダー認証が必要かどうかを定義します。
`url`	String	外部プロバイダーの URL アドレスを定義します。
`username`	String	認証プロセス中に使用されるユーザー名を定義します。

7.82.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

Expand

表7.111 リンクの概要
名前	型	Summary
`certificates`	Certificate[]	このプロバイダーに対してエンジンがサポートする証明書への参照。
`compute_resources`	ExternalComputeResource[]	ホストプロバイダーで表されるコンピュートリソースへの参照。
`discovered_hosts`	ExternalDiscoveredHost[]	ホストプロバイダーで検出されたホストへの参照。
`host_groups`	ExternalHostGroup[]	ホストプロバイダーのホストグループへの参照。
`hosts`	Host[]	ホストプロバイダーによってプロビジョニングされるホストへの参照。

7.82.2. compute_resources
リンクのコピー

ホストプロバイダーで表されるコンピュートリソースへの参照。各ホストプロバイダーには、必要に応じてコンピュートリソースとして定義されたエンジンがあり、エンジン内に仮想マシンを作成できます。このコンピュートリソースの詳細は、ハイパーバイザーをデプロイするために、ベアメタルプロビジョニングのユースケースで使用されます。

7.82.3. discovered_hosts
リンクのコピー

ホストプロバイダーで検出されたホストへの参照。検出されたホストは、まだプロビジョニングされていないホストです。

7.82.4. host_groups
リンクのコピー

ホストプロバイダーのホストグループへの参照。ホストグループには、ホストプロバイダーがこのグループのメンバーであるすべてのホストに適用するさまざまなプロパティーが含まれています。たとえばインストールされたソフトウェア、システム定義、パスワードなどです。

7.83. ExternalNetworkProviderConfiguration 構造体
リンクのコピー

ホスト上で外部ネットワークプロバイダーをプロビジョニングする方法を説明します。

Expand

表7.112 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.113 リンクの概要
名前	型	Summary
`external_network_provider`	ExternalProvider	外部ネットワークプロバイダーへのリンク。
`host`	ホスト	ホストへのリンク。

7.84. ExternalProvider 構造体
リンクのコピー

外部プロバイダーを表します。

Expand

表7.114 属性の概要
名前	型	Summary
`authentication_url`	String	外部プロバイダー認証 URL アドレスを定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`password`	String	認証プロセス中にユーザーのパスワードを定義します。
`properties`	Property[]	プロバイダー名/値のプロパティーの配列。
`requires_authentication`	ブール値	プロバイダー認証が必要かどうかを定義します。
`url`	String	外部プロバイダーの URL アドレスを定義します。
`username`	String	認証プロセス中に使用されるユーザー名を定義します。

7.84.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

7.85. ExternalStatus enum
リンクのコピー

外部からの状態を表します。現在、このステータスはホストとストレージドメインで使用され、外部システムが認識しているオブジェクトのステータスを更新できるようにします。

Expand

表7.115 値の概要
名前	Summary
`error`	エラーのステータス。
`failure`	失敗のステータス。
`info`	情報のステータス。
`ok`	OK のステータス。
`warning`	警告のステータス。

7.85.1. error
リンクのコピー

エラーのステータス。関連するオブジェクトに何らかのエラーがあります。

7.85.2. failure
リンクのコピー

失敗のステータス。関連するオブジェクトが失敗しています。

7.85.3. info
リンクのコピー

情報のステータス。関連するオブジェクトは OK ステータスですが、管理者に関連する可能性のある情報があります。

7.85.4. ok
リンクのコピー

OK のステータス。関連オブジェクトは正常に動作しています。

7.85.5. warning
リンクのコピー

警告のステータス。関連するオブジェクトは正常に機能していますが、管理者に関連する可能性のある警告がいくつかあります。

7.86. ExternalSystemType enum
リンクのコピー

step に関連する外部システムの種類を表す。

Expand

表7.116 値の概要
名前	Summary
`gluster`	`step` に関連する外部システムとして `Gluster` を表現する。
`vdsm`	`step` に関連する外部システムとして `VDSM` を表現する。

7.87. ExternalTemplateImport 構造体
リンクのコピー

外部システムからのテンプレートのインポート操作のパラメーターを説明します。現在、OVA のみをサポートしています。

Expand

表7.117 属性の概要
名前	型	Summary
`clone`	ブール値	オプション
`url`	String	エンジンに渡される URL。

7.87.1. clone
リンクのコピー

オプションインポートされたテンプレートの識別子を再生成する必要があるかどうかを示します。

デフォルトでは、テンプレートがインポートされると、識別子が保持されます。つまり、識別子は一意である必要があるため、同じテンプレートを複数回インポートすることはできません。同じテンプレートを複数回インポートできるようにするには、このパラメーターを true に設定します。デフォルトは false です。

7.87.2. url
リンクのコピー

エンジンに渡される URL。

以下に例を示します。

ova:///mnt/ova/ova_file.ova

ova:///mnt/ova/ova_file.ova

Copy to Clipboard

Toggle word wrap

Expand

表7.118 リンクの概要
名前	型	Summary
`cluster`	クラスター	結果のテンプレートのターゲットクラスターを指定します。
`cpu_profile`	CpuProfile	オプション
`host`	ホスト	OVA ファイルが存在するホストを指定します。
`quota`	クォータ	オプション
`storage_domain`	StorageDomain	ディスクのターゲットストレージドメインを指定します。
`template`	テンプレート	新しく作成されたテンプレートの名前を指定するために使用されるテンプレートエンティティー。

7.87.3. cpu_profile
リンクのコピー

オプション結果のテンプレートの CPU プロファイルを指定します。

7.87.4. quota
リンクのコピー

オプション結果のテンプレートに適用されるクォータを指定します。

7.87.5. template
リンクのコピー

新しく作成されたテンプレートの名前を指定するために使用されるテンプレートエンティティー。

名前が指定されていない場合は、ソーステンプレート名が使用されます。

7.88. ExternalVmImport struct
リンクのコピー

外部システムからの仮想マシンのインポート操作のパラメーターを説明します。

Expand

表7.119 属性の概要
名前	型	Summary
`name`	String	外部システム内で定義されている、インポートする仮想マシンの名前。
`password`	String	外部ハイパーバイザーシステムに対して認証するためのパスワード。
`provider`	ExternalVmProviderType	外部仮想マシンプロバイダーのタイプ。
`sparse`	ブール値	オプション
`url`	String	変換のために `virt-v2v` ツールに渡される URL。
`username`	String	外部ハイパーバイザーシステムに対して認証するためのユーザー名。

7.88.1. sparse
リンクのコピー

オプション結果の仮想マシンのディスク割り当てポリシーを指定します。sparse の場合は true、事前割り当ての場合は false になります。

指定されていない場合: - oVirt によって生成された OVA をインポートする場合、OVF 内のディスクの設定に従って決定されます。 - それ以外の場合は、true に設定されます。

7.88.2. url
リンクのコピー

変換のために virt-v2v ツールに渡される URL。

以下に例を示します。

vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1

vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1

Copy to Clipboard

Toggle word wrap

その他の例は、http://libguestfs.org/virt-v2v.1.html を参照してください。

Expand

表7.120 リンクの概要
名前	型	Summary
`cluster`	クラスター	結果の仮想マシンのターゲットクラスターを指定します。
`cpu_profile`	CpuProfile	オプション
`drivers_iso`	File	オプション
`host`	ホスト	オプション
`quota`	クォータ	オプション
`storage_domain`	StorageDomain	変換されたディスクのターゲットストレージドメインを指定します。
`vm`	Vm	新しく作成された仮想マシンの名前を指定するために使用される仮想マシンエンティティー。

7.88.3. cpu_profile
リンクのコピー

オプション結果の仮想マシンの CPU プロファイルを指定します。

7.88.4. drivers_iso
リンクのコピー

オプションvirt-v2v 変換プロセス中に使用できるドライバーを含む ISO の名前。

7.88.5. host
リンクのコピー

オプション変換プロセスに使用するホストを (ホスト ID を使用して) 指定します。指定されていない場合は、自動的に選択されます。

7.88.6. quota
リンクのコピー

オプション結果の仮想マシンに適用されるクォータを指定します。

7.88.7. vm
リンクのコピー

新しく作成された仮想マシンの名前を指定するために使用される仮想マシンエンティティー。

名前が指定されていない場合は、ソース仮想マシン名が使用されます。

7.89. ExternalVmProviderType enum
リンクのコピー

外部ハイパーバイザーシステムのタイプを説明します。

Expand

表7.121 値の概要
名前	Summary
`kvm`
`vmware`
`xen`

7.90. Fault 構造体
リンクのコピー

Expand

表7.122 属性の概要
名前	型	Summary
`detail`	String
`reason`	String

7.91. FenceType enum
リンクのコピー

フェンス操作のタイプを表すタイプ。

Expand

表7.123 値の概要
名前	Summary
`manual`	電源管理を介した手動のホストフェンシング。
`restart`	電源管理を介してホストを再起動します。
`start`	電源管理を介してホストを起動します。
`status`	電源管理を介してホストの電源ステータスを確認します。
`stop`	電源管理を介してホストを停止します。

7.92. FencingPolicy 構造体
リンクのコピー

クラスターフェンシングポリシーを表すタイプ。

Expand

表7.124 属性の概要
名前	型	Summary
`enabled`	ブール値	このクラスターでフェンシングを有効または無効にします。
`skip_if_connectivity_broken`	SkipIfConnectivityBroken	有効にすると、クラスター内の設定可能なパーセンテージを超えるホストが接続を失ってもホストのフェンシングは実行されません。
`skip_if_gluster_bricks_up`	ブール値	フェンシングされているホストで Gluster ブリックが稼働している場合、フェンシングをスキップする必要があるかどうかを示すフラグ。
`skip_if_gluster_quorum_not_met`	ブール値	Gluster ブリックが稼働中であり、Gluster クォーラムがそれらのブリックなしでは満たされない場合にフェンシングをスキップする必要があるかどうかを示すフラグ。
`skip_if_sd_active`	SkipIfSdActive	有効にすると、ホストがストレージでリースを維持している場合にフェンシングをスキップします。

7.92.1. skip_if_connectivity_broken
リンクのコピー

有効にすると、クラスター内の設定可能なパーセンテージを超えるホストが接続を失ってもホストのフェンシングは実行されません。これは、クラスター内でグローバルネットワークの問題が発生した場合にフェンシング ストーム を防ぐためです。

7.92.2. skip_if_gluster_bricks_up
リンクのコピー

フェンシングされているホストで Gluster ブリックが稼働している場合、フェンシングをスキップする必要があるかどうかを示すフラグ。このフラグはオプションで、デフォルト値は false です。

7.92.3. skip_if_gluster_quorum_not_met
リンクのコピー

Gluster ブリックが稼働中であり、Gluster クォーラムがそれらのブリックなしでは満たされない場合にフェンシングをスキップする必要があるかどうかを示すフラグ。このフラグはオプションで、デフォルト値は false です。

7.92.4. skip_if_sd_active
リンクのコピー

有効にすると、ホストがストレージでリースを維持している場合にフェンシングをスキップします。これは、ホストがまだストレージにアクセスできる場合、フェンシングされないことを意味します。

7.93. File 構造体
リンクのコピー

Expand

表7.125 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`content`	String
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`type`	String

Expand

表7.126 リンクの概要
名前	型	Summary
`storage_domain`	StorageDomain

7.94. Filter 構造体
リンクのコピー

Expand

表7.127 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`position`	Integer

Expand

表7.128 リンクの概要
名前	型	Summary
`scheduling_policy_unit`	SchedulingPolicyUnit

7.95. FipsMode enum
リンクのコピー

クラスターへの FIPS モードの表現。

Expand

表7.129 値の概要
名前	Summary
`disabled`	FIPS モードが無効になっている。
`enabled`	FIPS モードが有効です。
`undefined`	FIPS モードはまだ評価されていません。

7.95.1. disabled
リンクのコピー

FIPS モードが無効になっている。

これは、FIPS モードが無効になっており、その中のホストで FIPS モードが無効になっている必要があることを意味します。

7.95.2. enabled
リンクのコピー

FIPS モードが有効です。

これは、FIPS モードが有効になっており、その中のホストで FIPS モードが有効になっている必要があることを意味します。

7.95.3. undefined
リンクのコピー

FIPS モードはまだ評価されていません。

現時点で、これは FIPS モードが未定であることを意味します。ホストが追加されると、この値はホストの設定に従って切り替わります。

7.96. FirewallType enum
リンクのコピー

システムでサポートされているすべてのファイアウォールタイプを説明します。

Expand

表7.130 値の概要
名前	Summary
`firewalld`	FirewallD ファイアウォールタイプ。
`iptables`	IPTables ファイアウォールタイプ。

7.96.1. firewalld
リンクのコピー

FirewallD ファイアウォールタイプ。

クラスターのファイアウォールタイプが firewalld に設定されている場合、クラスター内のすべてのホストのファイアウォールは、firewalld を使用して設定されます。FirewallD は、バージョン 4.2 で IPTables を置き換えました。コマンドラインプログラムと動的設定を使用して設定を簡素化します。

7.96.2. iptables
リンクのコピー

IPTables ファイアウォールタイプ。

iptables は非推奨になりました。

7.97. Floppy 構造体
リンクのコピー

フロッピーファイルの基盤となる表現。

Expand

表7.131 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`file`	File	フロッピーデバイスのコンテンツとそのタイプを表すファイルオブジェクト。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.132 リンクの概要
名前	型	Summary
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.97.1. vms
リンクのコピー

7.98. FopStatistic struct
リンクのコピー

Expand

表7.133 属性の概要
名前	型	Summary
`name`	String
`statistics`	Statistic[]

7.99. GlusterBrick 構造体
リンクのコピー

Expand

表7.134 属性の概要
名前	型	Summary
`brick_dir`	String
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`device`	String
`fs_name`	String
`gluster_clients`	GlusterClient[]
`id`	String	一意の ID
`memory_pools`	GlusterMemoryPool[]
`mnt_options`	String
`name`	String	人間が判読できるプレーンテキストでの名前。
`pid`	Integer
`port`	Integer
`server_id`	String
`status`	GlusterBrickStatus

Expand

表7.135 リンクの概要
名前	型	Summary
`gluster_volume`	GlusterVolume
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`statistics`	Statistic[]
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.99.1. vms
リンクのコピー

7.100. GlusterBrickAdvancedDetails struct
リンクのコピー

Expand

表7.136 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`device`	String
`fs_name`	String
`gluster_clients`	GlusterClient[]
`id`	String	一意の ID
`memory_pools`	GlusterMemoryPool[]
`mnt_options`	String
`name`	String	人間が判読できるプレーンテキストでの名前。
`pid`	Integer
`port`	Integer

Expand

表7.137 リンクの概要
名前	型	Summary
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.100.1. vms
リンクのコピー

7.101. GlusterBrickMemoryInfo struct
リンクのコピー

Expand

表7.138 属性の概要
名前	型	Summary
`memory_pools`	GlusterMemoryPool[]

7.102. GlusterBrickStatus enum
リンクのコピー

Expand

表7.139 値の概要
名前	Summary
`down`	ブリックは `down` 状態です。データを保存したり、ブリックから取得したりできません。
`unknown`	ホストが応答していないため、ステータスを判別できない場合。
`up`	ブリックは `up` 状態にあり、データを保存したり、ブリックから取得したりできます。

7.103. GlusterClient 構造体
リンクのコピー

Expand

表7.140 属性の概要
名前	型	Summary
`bytes_read`	Integer
`bytes_written`	Integer
`client_port`	Integer
`host_name`	String

7.104. GlusterHook struct
リンクのコピー

Expand

表7.141 属性の概要
名前	型	Summary
`checksum`	String
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`conflict_status`	Integer
`conflicts`	String
`content`	String
`content_type`	HookContentType
`description`	String	プレーンテキストでの人間が判読できる説明。
`gluster_command`	String
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`stage`	HookStage
`status`	GlusterHookStatus

Expand

表7.142 リンクの概要
名前	型	Summary
`cluster`	クラスター
`server_hooks`	GlusterServerHook[]

7.105. GlusterHookStatus enum
リンクのコピー

Expand

表7.143 値の概要
名前	Summary
`disabled`	クラスターでフックが無効になっています。
`enabled`	クラスターでフックが有効になっています。
`missing`	フックのステータスが不明/欠落しています。

7.106. GlusterMemoryPool struct
リンクのコピー

Expand

表7.144 属性の概要
名前	型	Summary
`alloc_count`	Integer
`cold_count`	Integer
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`hot_count`	Integer
`id`	String	一意の ID
`max_alloc`	Integer
`max_stdalloc`	Integer
`name`	String	人間が判読できるプレーンテキストでの名前。
`padded_size`	Integer
`pool_misses`	Integer
`type`	String

7.107. GlusterServerHook struct
リンクのコピー

Expand

表7.145 属性の概要
名前	型	Summary
`checksum`	String
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`content_type`	HookContentType
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`status`	GlusterHookStatus

Expand

表7.146 リンクの概要
名前	型	Summary
`host`	ホスト

7.108. GlusterState enum
リンクのコピー

Expand

表7.147 値の概要
名前	Summary
`down`
`unknown`
`up`

7.109. GlusterVolume 構造体
リンクのコピー

Expand

表7.148 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`disperse_count`	Integer
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`options`	Option[]
`redundancy_count`	Integer
`replica_count`	Integer
`status`	GlusterVolumeStatus
`stripe_count`	Integer
`transport_types`	TransportType[]
`volume_type`	GlusterVolumeType

Expand

表7.149 リンクの概要
名前	型	Summary
`bricks`	GlusterBrick[]
`cluster`	クラスター
`statistics`	Statistic[]

7.110. GlusterVolumeProfileDetails struct
リンクのコピー

Expand

表7.150 属性の概要
名前	型	Summary
`brick_profile_details`	BrickProfileDetail[]
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`nfs_profile_details`	NfsProfileDetail[]

7.111. GlusterVolumeStatus enum
リンクのコピー

Expand

表7.151 値の概要
名前	Summary
`down`	クライアントがボリュームをマウントして使用できるようにするには、ボリュームを開始する必要があります。
`unknown`	ホストが応答していないため、ステータスを判別できない場合。
`up`	ボリュームが開始され、クライアントによるマウントおよび使用が可能です。

7.112. GlusterVolumeType enum
リンクのコピー

Gluster ボリュームのタイプを表すタイプ。

Expand

表7.152 値の概要
名前	Summary
`disperse`	Dispersed ボリュームは消去コードに基づいており、ディスクまたはサーバーの障害に対するスペース効率の高い保護を提供します。
`distribute`	分散ボリュームは、ボリューム内のブリック全体にファイルを分散します。
`distributed_disperse`	Distributed dispersed ボリュームは、分散サブボリューム全体にファイルを分散します。
`distributed_replicate`	Distributed replicated ボリュームは、ボリューム内の複製ブリック全体にファイルを分散します。
`distributed_stripe`	Distributed striped ボリュームは、クラスター内の 2 つ以上のノードにデータをストライプします。
`distributed_striped_replicate`	Distributed striped replicated ボリュームは、クラスター内の複製ブリック全体にストライプデータを分散します。
`replicate`	複製されたボリュームは、ボリューム内のブリック全体でファイルをレプリケートします。
`stripe`	Striped ボリュームは、ボリューム内のブリック全体にデータをストライプします。
`striped_replicate`	Striped replicated ボリュームは、クラスター内のレプリケートされたブリック全体にデータをストライプします。

7.112.1. disperse
リンクのコピー

Dispersed ボリュームは消去コードに基づいており、ディスクまたはサーバーの障害に対するスペース効率の高い保護を提供します。

元のファイルのエンコードされたフラグメントを各ブリックに分散させ、元のファイルを復元するためにフラグメントのサブセットのみが必要になるようにします。データへのアクセスを失わずに喪失するブリックの数は、ボリュームの作成時に管理者によって設定されます。

7.112.2. distribute
リンクのコピー

分散ボリュームは、ボリューム内のブリック全体にファイルを分散します。

Distributed ボリュームは、ストレージのスケーリングを必要とし、冗長性が重要でないか、他のハードウェア/ソフトウェア層によって提供される場合に使用できます。

7.112.3. distributed_disperse
リンクのコピー

Distributed dispersed ボリュームは、分散サブボリューム全体にファイルを分散します。

これには、distribute replicate ボリュームと同じ利点がありますが、disperse を使用してデータをブリックに格納します。

7.112.4. distributed_replicate
リンクのコピー

Distributed replicated ボリュームは、ボリューム内の複製ブリック全体にファイルを分散します。

ストレージのスケーリングに必要で、信頼性を高く保つことが重要な環境で、分散レプリケーションボリュームを使用できます。また、分散レプリケートされたボリュームは、ほとんどの環境で読み取りパフォーマンスも向上します。

7.112.5. distributed_stripe
リンクのコピー

Distributed striped ボリュームは、クラスター内の 2 つ以上のノードにデータをストライプします。

Distributed striped ボリュームは、ストレージのスケーリングが必要で、非常に大きなファイルにアクセスする同時実行性の高い環境が不可欠な場合に使用する必要があります。

注記: Glusterfs 3.7 リリースでのシャーディングの導入により、striped ボリュームは非推奨となり、今後のリリースで削除される予定です。

7.112.6. distributed_striped_replicate
リンクのコピー

Distributed striped replicated ボリュームは、クラスター内の複製ブリック全体にストライプデータを分散します。

最良の結果を得るために、非常に大きなファイルへの並列アクセスとパフォーマンスが重要な同時実行性の高い環境では、distributed striped replicated ボリュームを使用する必要があります。

注記: Glusterfs 3.7 リリースでのシャーディングの導入により、striped ボリュームは非推奨となり、今後のリリースで削除される予定です。

7.112.7. replicate
リンクのコピー

複製されたボリュームは、ボリューム内のブリック全体でファイルをレプリケートします。

レプリケーションされたボリュームは、高可用性と高信頼性が重要な環境で使用できます。

7.112.8. stripe
リンクのコピー

Striped ボリュームは、ボリューム内のブリック全体にデータをストライプします。

最良の結果を得るには、striped ボリュームは、非常に大きなファイルにアクセスする同時実行性の高い環境でのみ使用する必要があります。

注記: Glusterfs 3.7 リリースでのシャーディングの導入により、striped ボリュームは非推奨となり、今後のリリースで削除される予定です。

7.112.9. striped_replicate
リンクのコピー

Striped replicated ボリュームは、クラスター内のレプリケートされたブリック全体にデータをストライプします。

最良の結果を得るために、非常に大きなファイルへの並列アクセスが発生し、パフォーマンスが重要な同時実行性の高い環境では、striped replicated ボリュームを使用する必要があります。

注記: Glusterfs 3.7 リリースでのシャーディングの導入により、striped ボリュームは非推奨となり、今後のリリースで削除される予定です。

7.113. GracePeriod 構造体
リンクのコピー

Expand

表7.153 属性の概要
名前	型	Summary
`expiry`	Integer

7.114. GraphicsConsole 構造体
リンクのコピー

Expand

表7.154 属性の概要
名前	型	Summary
`address`	String
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`port`	Integer
`protocol`	GraphicsType
`tls_port`	Integer

Expand

表7.155 リンクの概要
名前	型	Summary
`instance_type`	InstanceType
`template`	テンプレート
`vm`	Vm

7.115. GraphicsType enum
リンクのコピー

グラフィックコンソールへの接続に使用されるグラフィックプロトコル。

Expand

表7.156 値の概要
名前	Summary
`spice`	SPICE タイプのグラフィックスプロトコル。
`vnc`	VNC タイプのグラフィックスプロトコル。

7.115.1. spice
リンクのコピー

SPICE タイプのグラフィックスプロトコル。詳細は、SPICE のドキュメントを参照してください。

7.115.2. vnc
リンクのコピー

VNC タイプのグラフィックスプロトコル。VNC は Virtual Network Computing の略で、RFB (Remote Frame Buffer) プロトコルを使用して別のマシンをリモートで制御するグラフィカルデスクトップ共有システムです。

7.116. Group 構造体
リンクのコピー

このタイプは、ディレクトリーサービス内のすべてのグループを表します。

Expand

表7.157 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`domain_entry_id`	String	含まれるディレクトリーサービスドメイン ID。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`namespace`	String	グループが存在する名前空間。

Expand

表7.158 リンクの概要
名前	型	Summary
`domain`	ドメイン	このグループを含むドメインへのリンク。
`permissions`	Permission[]	このグループにアタッチされたパーミッションのパーミッションサブコレクションへのリンク。
`roles`	Role[]	このグループにアタッチされたロールのロールサブコレクションへのリンク。
`tags`	Tag[]	このグループにアタッチされたタグのタグサブコレクションへのリンク。

7.116.1. roles
リンクのコピー

このグループにアタッチされたロールのロールサブコレクションへのリンク。

新しいグループの最初のロール割り当てを表すためにのみ使用されます。その後、ロール割り当ての変更は、roles サブコレクションを介してのみサポートされます。

7.117. GuestOperatingSystem struct
リンクのコピー

仮想マシンにインストールされているオペレーティングシステムを表します。

その情報を取得するには、次のようなリクエストを送信します。

GET /ovirt-engine/api/vms/123

GET /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

結果は以下のようになります。

<vm href="/ovirt-engine/api/vms/123" id="123">
...
  <guest_operating_system>
    <architecture>x86_64</architecture>
    <codename>Maipo</codename>
    <distribution>Red Hat Enterprise Linux Server</distribution>
    <family>Linux</family>
    <kernel>
      <version>
        <build>0</build>
        <full_version>3.10.0-514.10.2.el7.x86_64</full_version>
        <major>3</major>
        <minor>10</minor>
        <revision>514</revision>
      </version>
    </kernel>
    <version>
      <full_version>7.3</full_version>
      <major>7</major>
      <minor>3</minor>
    </version>
  </guest_operating_system>
</vm>

<vm href="/ovirt-engine/api/vms/123" id="123">
...
  <guest_operating_system>
    <architecture>x86_64</architecture>
    <codename>Maipo</codename>
    <distribution>Red Hat Enterprise Linux Server</distribution>
    <family>Linux</family>
    <kernel>
      <version>
        <build>0</build>
        <full_version>3.10.0-514.10.2.el7.x86_64</full_version>
        <major>3</major>
        <minor>10</minor>
        <revision>514</revision>
      </version>
    </kernel>
    <version>
      <full_version>7.3</full_version>
      <major>7</major>
      <minor>3</minor>
    </version>
  </guest_operating_system>
</vm>

Copy to Clipboard

Toggle word wrap

Expand

表7.159 属性の概要
名前	型	Summary
`architecture`	String	x86_64 などのオペレーティングシステムのアーキテクチャー。
`codename`	String	`Maipo` などのオペレーティングシステムのコードネーム。
`distribution`	String	オペレーティングシステムディストリビューションの完全な名前。
`family`	String	`Linux` などのオペレーティングシステムのファミリー。
`kernel`	カーネル	オペレーティングシステムのカーネルバージョン。
`version`	バージョン	インストールされているオペレーティングシステムのバージョン。

7.118. HardwareInformation 構造体
リンクのコピー

ホストのハードウェア情報を表します。

その情報を取得するには、次のようなリクエストを送信します。

GET /ovirt-engine/api/hosts/123

GET /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

結果は以下のようになります。

<host href="/ovirt-engine/api/hosts/123" id="123">
  ...
  <hardware_information>
    <family>Red Hat Enterprise Linux</family>
    <manufacturer>Red Hat</manufacturer>
    <product_name>RHEV Hypervisor</product_name>
    <serial_number>01234567-89AB-CDEF-0123-456789ABCDEF</serial_number>
    <supported_rng_sources>
      <supported_rng_source>random</supported_rng_source>
    </supported_rng_sources>
    <uuid>12345678-9ABC-DEF0-1234-56789ABCDEF0</uuid>
    <version>1.2-34.5.el7ev</version>
  </hardware_information>
  ...
</application>

<host href="/ovirt-engine/api/hosts/123" id="123">
  ...
  <hardware_information>
    <family>Red Hat Enterprise Linux</family>
    <manufacturer>Red Hat</manufacturer>
    <product_name>RHEV Hypervisor</product_name>
    <serial_number>01234567-89AB-CDEF-0123-456789ABCDEF</serial_number>
    <supported_rng_sources>
      <supported_rng_source>random</supported_rng_source>
    </supported_rng_sources>
    <uuid>12345678-9ABC-DEF0-1234-56789ABCDEF0</uuid>
    <version>1.2-34.5.el7ev</version>
  </hardware_information>
  ...
</application>

Copy to Clipboard

Toggle word wrap

Expand

表7.160 属性の概要
名前	型	Summary
`family`	String	ホストの CPU のタイプ。
`manufacturer`	String	ホストのマシンの製造元とハードウェアベンダー。
`product_name`	String	ホストの製品名 (例: `RHEV Hypervisor`)。
`serial_number`	String	ホストのシャーシの一意の ID。
`supported_rng_sources`	RngSource[]	サポートされている乱数ジェネレーターのソース。
`uuid`	String	各ホストの一意の ID。
`version`	String	各製造元の固有の名前。

7.119. HighAvailability 構造体
リンクのコピー

仮想マシンの高可用性を表すタイプ。

Expand

表7.161 属性の概要
名前	型	Summary
`enabled`	ブール値	仮想マシンが高可用性と見なされているかどうかを定義します。
`priority`	Integer	実行および移行キュー内の仮想マシンの優先度を示します。

7.119.1. enabled
リンクのコピー

仮想マシンが高可用性と見なされているかどうかを定義します。スプリットブレインのシナリオを防ぐには、仮想マシンのリースを設定することを強く推奨します (このセクションを参照)。ブートディスクのストレージドメインまたはその他のアクティブなストレージドメインを使用します。

7.119.2. priority
リンクのコピー

実行および移行キュー内の仮想マシンの優先度を示します。

優先度の高い仮想マシンは、優先度の低い仮想マシンより先に開始および移行されます。

値は 0 から 100 の整数です。値が高いと優先順位が高くなります。

グラフィカルユーザーインターフェイス (GUI) では、可能なすべての値を指定することはできません。代わりに、Low、Medium または High のいずれかのみ選択できます。API を使用して値を設定すると、GUI は次のようにラベルを設定します。

Expand

API 値	GUI ラベル
0 - 25	Low
26 - 74	Medium
75 - 100	High

GUI を使用してラベルを選択すると、API の値は次のように設定されます。

Expand

GUI ラベル	API 値
Low	1
Medium	50
High	100

7.120. Hook 構造体
リンクのコピー

フックを表します。

Expand

表7.162 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`event_name`	String	フックを実行するイベントの名前。
`id`	String	一意の ID
`md5`	String	フックのチェックサム。
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.163 リンクの概要
名前	型	Summary
`host`	ホスト	フックが属するホストへの参照。

7.121. HookContentType enum
リンクのコピー

フックスクリプトのコンテンツタイプを表します。

Expand

表7.164 値の概要
名前	Summary
`binary`	フックのバイナリーコンテンツタイプ。
`text`	フックのテキストコンテンツタイプ。

7.122. HookStage enum
リンクのコピー

タイプは、フックが実行されるボリュームイベントのステージを表します。

Expand

表7.165 値の概要
名前	Summary
`post`	ボリューム開始後のステージ。
`pre`	ボリューム開始前のステージ。

7.123. HookStatus enum
リンクのコピー

タイプはフックのステータスを表します。

Expand

表7.166 値の概要
名前	Summary
`disabled`	フックが無効になっています。
`enabled`	フックが有効になっています。
`missing`	フックがありません。

7.124. Host 構造体
リンクのコピー

ホストを表すタイプ。

Expand

表7.167 属性の概要
名前	型	Summary
`address`	String	ホストアドレス (FQDN/IP)。
`auto_numa_status`	AutoNumaStatus	ホストの自動 Non-Uniform Memory Access (NUMA) ステータス。
`certificate`	証明書	ホスト証明書。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`cpu`	Cpu	このホストの CPU タイプ。
`description`	String	プレーンテキストでの人間が判読できる説明。
`device_passthrough`	HostDevicePassthrough	このホストでホストデバイスのパススルーが有効であるかどうかを指定します。
`display`	表示	オプションで、このホストの表示アドレスを明示的に指定します。
`external_status`	ExternalStatus	ホストの外部ステータス。
`hardware_information`	HardwareInformation	ホストハードウェア情報。
`hosted_engine`	HostedEngine	このホストの自己ホスト型エンジンステータス。
`id`	String	一意の ID
`iscsi`	IscsiDetails	ホスト iSCSI の詳細。
`kdump_status`	KdumpStatus	ホストの KDUMP ステータス。
`ksm`	Ksm	Kernel SamePage Merging(KSM) は、複数の同一ページから 1 つのページ参照にメモリーページへの参照を削減します。
`libvirt_version`	バージョン	ホストの libvirt バージョン。
`max_scheduling_memory`	Integer	このホストの最大スケジューリングメモリー (バイト単位)。
`memory`	Integer	このホストの物理メモリーの量 (バイト単位)。
`name`	String	人間が判読できるプレーンテキストでの名前。
`network_operation_in_progress`	ブール値	'setup networks'、'sync networks'、または 'refresh capabilities' などのネットワーク関連の操作が現在このホストで実行されているかどうかを指定します。
`numa_supported`	ブール値	このホストで Non-Uniform Memory Access (NUMA) をサポートしているかどうかを指定します。
`os`	OperatingSystem	このホストのオペレーティングシステム。
`override_iptables`	ブール値	ファイアウォール定義をオーバーライドする必要があるかどうかを指定します。
`ovn_configured`	ブール値	ホストが OVN を正しく設定したかどうかを示します。
`port`	Integer	ホストポート。
`power_management`	PowerManagement	ホストの電源管理の定義。
`protocol`	HostProtocol	エンジンがホストとの通信に使用するプロトコル。
`reinstallation_required`	ブール値	ホストを再インストールする必要があるかどうかを指定します。
`root_password`	String	新しいホストを作成するときに、パスワード認証方法を選択した場合は root パスワードが必要ですが、これはその後の表現には含まれません。
`se_linux`	SeLinux	ホストの SElinux ステータス。
`spm`	Spm	ホスト Storage Pool Manager (SPM) のステータスと定義。
`ssh`	Ssh	SSH 定義。
`status`	HostStatus	ホストのステータス。
`status_detail`	String	ホストステータスの詳細。
`summary`	VmSummary	仮想マシンの概要 - アクティブ数、移行数、および合計数。
`transparent_huge_pages`	TransparentHugePages	透過的な Huge Page のサポートにより、メモリーページのサイズが標準の 4 KiB の制限を超えて拡張されます。
`type`	HostType	ホストにオペレーティングシステムのフルインストールが含まれているか、仮想マシンをホストすることのみを目的とした縮小版が含まれているかを示します。
`update_available`	ブール値	このホストに oVirt 関連の更新があるかどうかを指定します。
`version`	バージョン	VDSM のバージョン。
`vgpu_placement`	VgpuPlacement	vGPU 配置ストラテジーを指定します。

7.124.1. external_status
リンクのコピー

ホストの外部ステータス。これは、サードパーティーのソフトウェアが、問題が発生した場合にホスト外部のステータスを変更するために使用することができます。サードパーティーのソフトウェアがこのステータスをチェックしてそれに応じて行動しない限り、これはホストのライフサイクルに影響を与えません。

7.124.2. hosted_engine
リンクのコピー

このホストの自己ホスト型エンジンステータス。

重要

ホストまたはホストのコレクションが取得されるとき、操作の all_content パラメーターが明示的に true に設定されていない限り、この属性は含まれません。詳細は、ホスト 1 つまたは複数を取得する操作のドキュメントを参照してください。

7.124.3. kdump_status
リンクのコピー

ホストの KDUMP ステータス。KDUMP は、ホストカーネルがクラッシュし、メモリーダンプが実行されているときに発生します。

7.124.4. ksm
リンクのコピー

Kernel SamePage Merging(KSM) は、複数の同一ページから 1 つのページ参照にメモリーページへの参照を削減します。これは、メモリー密度の最適化に役立ちます。

たとえば、ホスト 123 に対して KSM を有効にするには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/hosts/123

PUT /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

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

<host>
  <ksm>
    <enabled>true</enabled>
  </ksm>
</host>

<host>
  <ksm>
    <enabled>true</enabled>
  </ksm>
</host>

Copy to Clipboard

Toggle word wrap

7.124.5. libvirt_version
リンクのコピー

ホストの libvirt バージョン。libvirt の詳細は、libvirt を参照してください。

7.124.6. network_operation_in_progress
リンクのコピー

'setup networks'、'sync networks'、または 'refresh capabilities' などのネットワーク関連の操作が現在このホストで実行されているかどうかを指定します。

注記

この属性を応答に含めるには、ヘッダー All-Content:true を要求に追加する必要があります。

7.124.7. override_iptables
リンクのコピー

ファイアウォール定義をオーバーライドする必要があるかどうかを指定します。これは、ホストがインストールまたは再インストールされた場合にのみ適用されます。

7.124.8. protocol
リンクのコピー

エンジンがホストとの通信に使用するプロトコル。

警告

エンジンのバージョン 4.1 以降、xml が削除されたため、プロトコルは常に stomp に設定されています。

7.124.9. se_linux
リンクのコピー

ホストの SElinux ステータス。Security-Enhanced Linux (SELinux) は、アクセス制御セキュリティーポリシーをサポートするためのメカニズムを提供する Linux カーネルのコンポーネントです。

7.124.10. spm
リンクのコピー

ホスト Storage Pool Manager (SPM) のステータスと定義。これを使用して、このホストの SPM 優先度を設定し、これが現在の SPM であるかどうかを確認します。

7.124.11. status_detail
リンクのコピー

ホストステータスの詳細。Gluster ホストに関連します。

7.124.12. transparent_huge_pages
リンクのコピー

透過的な Huge Page のサポートにより、メモリーページのサイズが標準の 4 KiB の制限を超えて拡張されます。これにより、メモリー消費が削減され、ホストのパフォーマンスが向上します。

たとえば、ホスト 123 の透過的な Huge Page のサポートを有効にするには、次のようなリクエストを送信します。

PUT /ovirt-engine/api/hosts/123

PUT /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

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

<host>
  <transparent_hugepages>
    <enabled>true</enabled>
  </transparent_hugepages>
</host>

<host>
  <transparent_hugepages>
    <enabled>true</enabled>
  </transparent_hugepages>
</host>

Copy to Clipboard

Toggle word wrap

7.124.13. version
リンクのコピー

VDSM のバージョン。

以下に例を示します。

GET /ovirt-engine/api/hosts/123

GET /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

この GET リクエストは、以下の出力を返します。

<host>
  ...
  <version>
    <build>999</build>
    <full_version>vdsm-4.18.999-419.gitcf06367.el7</full_version>
    <major>4</major>
    <minor>18</minor>
    <revision>0</revision>
  </version>
  ...
</host>

<host>
  ...
  <version>
    <build>999</build>
    <full_version>vdsm-4.18.999-419.gitcf06367.el7</full_version>
    <major>4</major>
    <minor>18</minor>
    <revision>0</revision>
  </version>
  ...
</host>

Copy to Clipboard

Toggle word wrap

Expand

表7.168 リンクの概要
名前	型	Summary
`affinity_labels`	AffinityLabel[]
`agents`	Agent[]
`cluster`	クラスター
`cpu_units`	HostCpuUnit[]	トポロジー (ソケット、コア) に関する詳細情報と、現在の CPU ピン留めに関する情報を含むすべてのホストの CPU のリスト。
`devices`	HostDevice[]
`external_host_provider`	ExternalHostProvider
`external_network_provider_configurations`	ExternalNetworkProviderConfiguration[]	ホスト上でプロビジョニングされた外部ネットワークプロバイダー。
`hooks`	Hook[]
`katello_errata`	KatelloErratum[]	ホストに割り当てられているすべての Katello エラータをリスト表示します。
`network_attachments`	NetworkAttachment[]
`nics`	HostNic[]
`numa_nodes`	NumaNode[]
`permissions`	Permission[]
`statistics`	Statistic[]	各ホストリソースは、ホスト固有の統計の統計サブコレクションを公開します。
`storage_connection_extensions`	StorageConnectionExtension[]
`storages`	HostStorage[]
`tags`	Tag[]
`unmanaged_networks`	UnmanagedNetwork[]

7.124.14. cpu_units
リンクのコピー

トポロジー (ソケット、コア) に関する詳細情報と、現在の CPU ピン留めに関する情報を含むすべてのホストの CPU のリスト。

GET /ovirt-engine/api/hosts/123/cpuunits

GET /ovirt-engine/api/hosts/123/cpuunits

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<host_cpu_units>
  <host_cpu_unit>
    <core_id>0</core_id>
    <cpu_id>0</cpu_id>
    <socket_id>0</socket_id>
    <vms>
      <vm href="/ovirt-engine/api/vms/def" id="def" />
    </vms>
  </host_cpu_unit>
  <host_cpu_unit>
    <core_id>0</core_id>
    <cpu_id>1</cpu_id>
    <socket_id>1</socket_id>
    <runs_vdsm>true</runs_vdsm>
  </host_cpu_unit>
  <host_cpu_unit>
    <core_id>0</core_id>
    <cpu_id>2</cpu_id>
    <socket_id>2</socket_id>
  </host_cpu_unit>
</host_cpu_units>

<host_cpu_units>
  <host_cpu_unit>
    <core_id>0</core_id>
    <cpu_id>0</cpu_id>
    <socket_id>0</socket_id>
    <vms>
      <vm href="/ovirt-engine/api/vms/def" id="def" />
    </vms>
  </host_cpu_unit>
  <host_cpu_unit>
    <core_id>0</core_id>
    <cpu_id>1</cpu_id>
    <socket_id>1</socket_id>
    <runs_vdsm>true</runs_vdsm>
  </host_cpu_unit>
  <host_cpu_unit>
    <core_id>0</core_id>
    <cpu_id>2</cpu_id>
    <socket_id>2</socket_id>
  </host_cpu_unit>
</host_cpu_units>

Copy to Clipboard

Toggle word wrap

7.124.15. external_network_provider_configurations
リンクのコピー

ホスト上でプロビジョニングされた外部ネットワークプロバイダー。

この属性は読み取り専用です。これを設定しても、ホストには影響しません。このパラメーターの値は、クラスターの Default Network Provider を反映しています。

7.124.16. katello_errata
リンクのコピー

ホストに割り当てられているすべての Katello エラータをリスト表示します。

GET /ovirt-engine/api/hosts/123/katelloerrata

GET /ovirt-engine/api/hosts/123/katelloerrata

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

Copy to Clipboard

Toggle word wrap

7.124.17. statistics
リンクのコピー

各ホストリソースは、ホスト固有の統計の統計サブコレクションを公開します。

XML 表現の例:

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/statistics/456" id="456">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host href="/ovirt-engine/api/hosts/123" id="123"/>
  </statistic>
    ...
</statistics>

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/statistics/456" id="456">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host href="/ovirt-engine/api/hosts/123" id="123"/>
  </statistic>
    ...
</statistics>

Copy to Clipboard

Toggle word wrap

注記

この統計サブコレクションは読み取り専用です。

次のリストは、ホストの統計タイプを示しています。

Expand

名前	説明
`memory.total`	ホスト上の合計メモリー (バイト単位)。
`memory.used`	ホストで使用されるバイト単位のメモリー。
`memory.free`	ホスト上の空きメモリー (バイト単位)。
`memory.shared`	ホスト上で共有しているメモリー (バイト単位)。
`memory.buffers`	バイト単位の I/O バッファー。
`memory.cached`	OS のキャッシュ (バイト単位)。
`swap.total`	ホスト上の合計スワップメモリー (バイト単位)。
`swap.free`	ホスト上の空きスワップメモリー (バイト単位)。
`swap.used`	ホスト上で使用されているスワップメモリー (バイト単位)。
`swap.cached`	バイト単位のスワップメモリーもホストのメモリーにキャッシュされます。
`ksm.cpu.current`	カーネル SamePage マージの CPU 使用率。
`cpu.current.user`	ユーザースライスの CPU 使用率。
`cpu.current.system`	システムの CPU 使用率。
`cpu.current.idle`	アイドル状態の CPU 使用率。
`cpu.load.avg.5m`	5 分あたりの CPU 負荷の平均。
`boot.time`	マシンの起動時間。

7.125. HostCpuUnit struct
リンクのコピー

現在のピン留めステータスを示すホストの物理 CPU を表すタイプ。

Expand

表7.169 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`core_id`	Integer	CPU が属するコアの ID。
`cpu_id`	Integer	CPU の ID。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`runs_vdsm`	ブール値	CPU が VDSM を実行していることを示すフラグ
`socket_id`	Integer	CPU が属するソケットの ID。

Expand

表7.170 リンクの概要
名前	型	Summary
`vms`	Vm[]	仮想 CPU がこの物理 CPU に固定されている VM のリスト。

7.126. HostDevice 構造体
リンクのコピー

Expand

表7.171 属性の概要
名前	型	Summary
`capability`	String
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`driver`	String	このデバイスがバインドされているドライバーの名前。
`id`	String	一意の ID
`iommu_group`	Integer
`m_dev_types`	MDevType[]	物理デバイス上でサポートされているすべての mdev タイプのリスト。
`name`	String	人間が判読できるプレーンテキストでの名前。
`physical_function`	HostDevice
`placeholder`	ブール値
`product`	製品
`vendor`	Vendor
`virtual_functions`	Integer

7.126.1. driver
リンクのコピー

このデバイスがバインドされているドライバーの名前。

例: pcieport または uhci_hcd。

Expand

表7.172 リンクの概要
名前	型	Summary
`host`	ホスト
`parent_device`	HostDevice
`vm`	Vm

7.127. HostDevicePassthrough 構造体
リンクのコピー

Expand

表7.173 属性の概要
名前	型	Summary
`enabled`	ブール値

7.128. HostNic struct
リンクのコピー

ホスト NIC を表します。

たとえば、ホスト NIC の XML 表現は次のようになります。

<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456">
  <name>eth0</name>
  <boot_protocol>static</boot_protocol>
  <bridged>true</bridged>
  <custom_configuration>true</custom_configuration>
  <ip>
    <address>192.168.122.39</address>
    <gateway>192.168.122.1</gateway>
    <netmask>255.255.255.0</netmask>
    <version>v4</version>
  </ip>
  <ipv6>
    <gateway>::</gateway>
    <version>v6</version>
  </ipv6>
  <ipv6_boot_protocol>none</ipv6_boot_protocol>
  <mac>
    <address>52:54:00:0c:79:1d</address>
  </mac>
  <mtu>1500</mtu>
  <status>up</status>
</host_nic>

<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456">
  <name>eth0</name>
  <boot_protocol>static</boot_protocol>
  <bridged>true</bridged>
  <custom_configuration>true</custom_configuration>
  <ip>
    <address>192.168.122.39</address>
    <gateway>192.168.122.1</gateway>
    <netmask>255.255.255.0</netmask>
    <version>v4</version>
  </ip>
  <ipv6>
    <gateway>::</gateway>
    <version>v6</version>
  </ipv6>
  <ipv6_boot_protocol>none</ipv6_boot_protocol>
  <mac>
    <address>52:54:00:0c:79:1d</address>
  </mac>
  <mtu>1500</mtu>
  <status>up</status>
</host_nic>

Copy to Clipboard

Toggle word wrap

ボンディングされたインターフェイスは、bonding 属性と slaves 属性を含む HostNic オブジェクトとして表されます。

たとえば、ボンディングされたホスト NIC の XML 表現は次のようになります。

<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456">
  <name>bond0</name>
  <mac address="00:00:00:00:00:00"/>
  <ip>
    <address>192.168.122.39</address>
    <gateway>192.168.122.1</gateway>
    <netmask>255.255.255.0</netmask>
    <version>v4</version>
  </ip>
  <boot_protocol>dhcp</boot_protocol>
  <bonding>
    <options>
      <option>
        <name>mode</name>
        <value>4</value>
        <type>Dynamic link aggregation (802.3ad)</type>
      </option>
      <option>
        <name>miimon</name>
        <value>100</value>
      </option>
    </options>
    <slaves>
      <host_nic id="123"/>
      <host_nic id="456"/>
    </slaves>
  </bonding>
  <mtu>1500</mtu>
  <bridged>true</bridged>
  <custom_configuration>false</custom_configuration>
</host_nic>

<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456">
  <name>bond0</name>
  <mac address="00:00:00:00:00:00"/>
  <ip>
    <address>192.168.122.39</address>
    <gateway>192.168.122.1</gateway>
    <netmask>255.255.255.0</netmask>
    <version>v4</version>
  </ip>
  <boot_protocol>dhcp</boot_protocol>
  <bonding>
    <options>
      <option>
        <name>mode</name>
        <value>4</value>
        <type>Dynamic link aggregation (802.3ad)</type>
      </option>
      <option>
        <name>miimon</name>
        <value>100</value>
      </option>
    </options>
    <slaves>
      <host_nic id="123"/>
      <host_nic id="456"/>
    </slaves>
  </bonding>
  <mtu>1500</mtu>
  <bridged>true</bridged>
  <custom_configuration>false</custom_configuration>
</host_nic>

Copy to Clipboard

Toggle word wrap

Expand

表7.174 属性の概要
名前	型	Summary
`ad_aggregator_id`	Integer	モード 4 のボンドの場合、ボンドまたはボンドスレーブの `ad_aggregator_id` プロパティー。
`base_interface`	String	NIC のベースインターフェイス。
`bonding`	ボンディング	NIC のボンディングパラメーター。
`boot_protocol`	BootProtocol	NIC の IPv4 ブートプロトコル設定。
`bridged`	ブール値	ブリッジネットワークのステータスを定義します。
`check_connectivity`	ブール値
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`custom_configuration`	ブール値
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`ip`	Ip	NIC の IPv4 アドレス。
`ipv6`	Ip	NIC の IPv6 アドレス。
`ipv6_boot_protocol`	BootProtocol	NIC の IPv6 ブートプロトコル設定。
`mac`	Mac	NIC の MAC アドレス。
`mtu`	Integer	インターフェイスの最大伝送単位。
`name`	String	人間が判読できるプレーンテキストでの名前。
`override_configuration`	ブール値
`properties`	Property[]
`speed`	Integer
`status`	NicStatus
`virtual_functions_configuration`	HostNicVirtualFunctionsConfiguration	物理機能 NIC の仮想機能設定を説明します。
`vlan`	Vlan

7.128.1. ad_aggregator_id
リンクのコピー

モード 4 のボンドの場合、ボンドまたはボンドスレーブの ad_aggregator_id プロパティー。ボンディングモード 4 は 802.3ad 標準であり、動的リンクアグリゲーションとも呼ばれます。(詳細は、ウィキペディアやプレゼンテーションを参照)。これは、モード 4 のボンディング、またはボンディングの一部である NIC にのみ有効です。他のモードのボンディング、またはモード 4 のボンディングの一部ではない NIC には存在しません。ad_aggregator_id プロパティーは、どのボンディングスレーブがアクティブであるかを示します。アクティブなスレーブの ad_aggregator_id の値は、ボンディングの ad_aggregator_id プロパティーの値と同じです。このパラメーターは読み取り専用です。設定してもボンディング/NIC には影響しません。これは、ボンディングの場合は /sys/class/net/bondX/bonding/ad_aggregator ファイルから、NIC の場合は /sys/class/net/ensX/bonding_slave/ad_aggregator_id ファイルから取得されます。

7.128.2. bridged
リンクのコピー

ブリッジネットワークのステータスを定義します。ブリッジネットワークの場合は true に設定し、ブリッジレスネットワークの場合は false に設定します。

Expand

表7.175 リンクの概要
名前	型	Summary
`host`	ホスト
`network`	Network	インターフェイスが接続するネットワークへの参照。
`network_labels`	NetworkLabel[]	この NIC に適用されるラベル。
`physical_function`	HostNic	SR-IOV Virtual Function NIC の Physical Function NIC への参照。
`qos`	Qos	インターフェイスの quality-of-service 設定へのリンク。
`statistics`	Statistic[]	NIC の統計へのリンク。

7.128.3. network
リンクのコピー

インターフェイスが接続するネットワークへの参照。空白のネットワーク ID を使用できます。

7.128.4. statistics
リンクのコピー

NIC の統計へのリンク。

HostNic 統計値のデータタイプ :

data.current.rx - 受信したデータの 1 秒あたりのバイト数。
data.current.tx - 送信されたデータ速度 (バイト毎秒)。
data.current.rx.bps - 受信したデータ速度 (ビット毎秒、バージョン 4.2 以降)。
data.current.tx.bps - 送信されたデータ速度 (ビット毎秒、バージョン 4.2 以降)。
data.total.rx - 受信したデータの合計。
data.total.tx - 送信されたデータの合計。
errors.total.rx - データの受信によるエラーの合計。
errors.total.tx - データの送信によるエラーの合計。

7.129. HostNicVirtualFunctionsConfiguration struct
リンクのコピー

SR-IOV 対応の物理機能 NIC の仮想機能設定を説明します。

Expand

表7.176 属性の概要
名前	型	Summary
`all_networks_allowed`	ブール値	関連する仮想関数にすべてのネットワークを定義することを許可するか、指定したネットワークのみを許可するかを定義します。
`max_number_of_virtual_functions`	Integer	NIC がサポートする仮想機能の最大数。
`number_of_virtual_functions`	Integer	現在定義されている仮想関数の数。

7.129.1. max_number_of_virtual_functions
リンクのコピー

NIC がサポートする仮想機能の最大数。このプロパティーは読み取り専用です。

7.129.2. number_of_virtual_functions
リンクのコピー

現在定義されている仮想関数の数。0 から max_number_of_virtual_functions までのユーザー定義値。

7.130. HostProtocol enum
リンクのコピー

エンジンがホストと通信するために使用するプロトコル。

警告

エンジンのバージョン 4.1 以降、xml が削除されたため、プロトコルは常に stomp に設定されています。

Expand

表7.177 値の概要
名前	Summary
`stomp`	STOMP 上の JSON-RPC プロトコル。
`xml`	XML-RPC プロトコル。

7.131. HostStatus enum
リンクのコピー

ホストステータスを表すタイプ。

Expand

表7.178 値の概要
名前	Summary
`connecting`	エンジンは特定のしきい値の場合はホストと通信できないので、現時点ではフェンシングを通過する前に接続を試みています。
`down`	ホストがダウンしています。
`error`	ホストはエラーステータスにあります。
`initializing`	ホストは初期化中です。
`install_failed`	ホストのインストールに失敗しました。
`installing`	ホストがインストールされています。
`installing_os`	これで、ホストオペレーティングシステムがインストールされます。
`kdumping`	ホストカーネルがクラッシュし、メモリーダンプが実行されています。
`maintenance`	ホストのステータスは maintenance です。
`non_operational`	ホストは動作しません。
`non_responsive`	ホストは応答しません。
`pending_approval`	ホストは管理者の承認を待っています。
`preparing_for_maintenance`	ホストはメンテナンスの準備をしています。
`reboot`	ホストは再起動されています。
`unassigned`	ホストはアクティブ化プロセス中です。
`up`	ホストが稼働しています。

7.131.1. error
リンクのコピー

ホストはエラーステータスにあります。これは、仮想マシンを何度か実行しようとして失敗した場合に発生します。

7.131.2. initializing
リンクのコピー

ホストは初期化中です。これは、ホストを 'up' ステータスに移行する前の中間のステップです。

7.131.3. install_failed
リンクのコピー

ホストのインストールに失敗しました。このような場合は、イベントログを参照して、インストールに失敗した原因を把握し、再インストールを実行してください。

7.131.4. installing_os
リンクのコピー

これで、ホストオペレーティングシステムがインストールされます。このステータスは、Satellite/Foreman プロバイダーを使用し、ベアメタルプロビジョニング (検出されたホストプロビジョニング) を発行する場合に関連します。

7.131.5. maintenance
リンクのコピー

ホストのステータスは maintenance です。ホストがメンテナンス中の場合、仮想マシンを実行できません。

7.131.6. non_operational
リンクのコピー

ホストは動作しません。これは、ストレージとの接続がない、必須ネットワークがサポートされていない、クラスターレベルがサポートされていないなど、さまざまな理由で発生する可能性があります。

7.131.7. non_responsive
リンクのコピー

ホストは応答しません。これは、エンジンがホストと通信できないことを意味します。

7.131.8. pending_approval
リンクのコピー

ホストは管理者の承認を待っています。これは、ヴィンテージの ovirt-node / RHV-H にのみ関連します。Vintage Node はサポートされなくなり、非推奨となったため、このプロパティーは関連しなくなりました。

7.131.9. preparing_for_maintenance
リンクのコピー

ホストはメンテナンスの準備をしています。この間、エンジンはすべての仮想マシンをこのホストから他のホストにライブマイグレーションします。すべての移行が完了すると、ホストは 'maintenance' ステータスに移行します。

7.132. HostStorage 構造体
リンクのコピー

Expand

表7.179 属性の概要
名前	型	Summary
`address`	String
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`driver_options`	Property[]	cinder ドライバーを使用してストレージドメインを作成するときに渡されるオプション。
`driver_sensitive_options`	Property[]	cinder ドライバーを使用してストレージドメインを作成するときに渡される機密情報を含むパラメーター。
`id`	String	一意の ID
`logical_units`	LogicalUnit[]
`mount_options`	String
`name`	String	人間が判読できるプレーンテキストでの名前。
`nfs_retrans`	Integer	さらなるリカバリーアクションを試みる前に、リクエストを再試行する回数。
`nfs_timeo`	Integer	NFS 要求を再試行する前に応答を待つ時間 (10 分の 1 秒単位)。
`nfs_version`	NfsVersion
`override_luns`	ブール値
`password`	String
`path`	String
`port`	Integer
`portal`	String
`target`	String
`type`	StorageType
`username`	String
`vfs_type`	String
`volume_group`	VolumeGroup

7.132.1. driver_options
リンクのコピー

cinder ドライバーを使用してストレージドメインを作成するときに渡されるオプション。

以下に例を示します (Kaminario バックエンド):

POST /ovirt-engine/api/storagedomains/

POST /ovirt-engine/api/storagedomains/

Copy to Clipboard

Toggle word wrap

<storage_domain>
 <name>kamniraio-cinder</name>
 <type>managed_block_storage</type>
 <storage>
   <type>managed_block_storage</type>
   <driver_options>
     <property>
       <name>san_ip</name>
       <value>192.168.1.1</value>
     </property>
     <property>
       <name>san_login</name>
       <value>username</value>
     </property>
     <property>
       <name>san_password</name>
       <value>password</value>
     </property>
     <property>
       <name>use_multipath_for_image_xfer</name>
       <value>true</value>
     </property>
     <property>
       <name>volume_driver</name>
       <value>cinder.volume.drivers.kaminario.kaminario_iscsi.KaminarioISCSIDriver</value>
     </property>
   </driver_options>
 </storage>
 <host>
   <name>host</name>
   </host>
</storage_domain>

<storage_domain>
 <name>kamniraio-cinder</name>
 <type>managed_block_storage</type>
 <storage>
   <type>managed_block_storage</type>
   <driver_options>
     <property>
       <name>san_ip</name>
       <value>192.168.1.1</value>
     </property>
     <property>
       <name>san_login</name>
       <value>username</value>
     </property>
     <property>
       <name>san_password</name>
       <value>password</value>
     </property>
     <property>
       <name>use_multipath_for_image_xfer</name>
       <value>true</value>
     </property>
     <property>
       <name>volume_driver</name>
       <value>cinder.volume.drivers.kaminario.kaminario_iscsi.KaminarioISCSIDriver</value>
     </property>
   </driver_options>
 </storage>
 <host>
   <name>host</name>
   </host>
</storage_domain>

Copy to Clipboard

Toggle word wrap

7.132.2. driver_sensitive_options
リンクのコピー

cinder ドライバーを使用してストレージドメインを作成するときに渡される機密情報を含むパラメーター。これらのパラメーターは、保存時に暗号化されます。

たとえば、次の XML は、ユーザー名、パスワード、および SAN IP アドレスを暗号化して保存します。

POST /ovirt-engine/api/storagedomains/

POST /ovirt-engine/api/storagedomains/

Copy to Clipboard

Toggle word wrap

<storage_domain>
 <name>kamniraio-cinder</name>
 <type>managed_block_storage</type>
 <storage>
   <type>managed_block_storage</type>
   <driver_options>
     <property>
       <name>san_ip</name>
       <value>192.168.1.1</value>
     </property>
     <property>
       <name>san_login</name>
       <value>username</value>
     </property>
     <property>
       <name>san_password</name>
       <value>password</value>
     </property>
     <property>
       <name>use_multipath_for_image_xfer</name>
       <value>true</value>
     </property>
     <property>
       <name>volume_driver</name>
       <value>cinder.volume.drivers.kaminario.kaminario_iscsi.KaminarioISCSIDriver</value>
     </property>
   </driver_options>
   <driver_sensitive_options>
     <property>
       <name>username</name>
       <value>admin</value>
     </property>
     <property>
       <name>password</name>
       <value>123</value>
     </property>
     <property>
       <name>san_ip</name>
       <value>192.168.1.1</value>
     </property>
   </driver_sensitive_options>
 </storage>
 <host>
   <name>host</name>
 </host>
</storage_domain>

<storage_domain>
 <name>kamniraio-cinder</name>
 <type>managed_block_storage</type>
 <storage>
   <type>managed_block_storage</type>
   <driver_options>
     <property>
       <name>san_ip</name>
       <value>192.168.1.1</value>
     </property>
     <property>
       <name>san_login</name>
       <value>username</value>
     </property>
     <property>
       <name>san_password</name>
       <value>password</value>
     </property>
     <property>
       <name>use_multipath_for_image_xfer</name>
       <value>true</value>
     </property>
     <property>
       <name>volume_driver</name>
       <value>cinder.volume.drivers.kaminario.kaminario_iscsi.KaminarioISCSIDriver</value>
     </property>
   </driver_options>
   <driver_sensitive_options>
     <property>
       <name>username</name>
       <value>admin</value>
     </property>
     <property>
       <name>password</name>
       <value>123</value>
     </property>
     <property>
       <name>san_ip</name>
       <value>192.168.1.1</value>
     </property>
   </driver_sensitive_options>
 </storage>
 <host>
   <name>host</name>
 </host>
</storage_domain>

Copy to Clipboard

Toggle word wrap

7.132.3. nfs_retrans
リンクのコピー

さらなるリカバリーアクションを試みる前に、リクエストを再試行する回数。値は 0 から 65535 の範囲に指定する必要があります。詳細は、nfs の man ページの retrans マウントオプションの説明を参照してください。

7.132.4. nfs_timeo
リンクのコピー

NFS 要求を再試行する前に応答を待つ時間 (10 分の 1 秒単位)。値は 0 から 65535 の範囲に指定する必要があります。詳細は、nfs の man ページの timeo マウントオプションの説明を参照してください。

Expand

表7.180 リンクの概要
名前	型	Summary
`host`	ホスト

7.133. HostType enum
リンクのコピー

この列挙型は、ホストが使用するオペレーティングシステムのタイプを判別するために使用されます。

Expand

表7.181 値の概要
名前	Summary
`ovirt_node`	ホストには、Red Hat Virtualization Host (RHVH) が含まれています。これは、Red Hat Enterprise Linux、CentOS、または Fedora と同じインストーラーを使用する Red Hat Enterprise Virtualization Hypervisor (RHEV-H) の新しい実装です。
`rhel`	ホストには、Red Hat Enterprise Linux、CentOS、または Fedora の完全なインストールが含まれています。
`rhev_h`	ホストには、Red Hat Enterprise Linux、CentOS、または Fedora の小規模バージョンである Red Hat Enterprise Virtualization Hypervisor (RHEV-H) が含まれており、仮想マシンをホストするためだけに使用されます。

7.133.1. ovirt_node
リンクのコピー

ホストには、Red Hat Virtualization Host (RHVH) が含まれています。これは、Red Hat Enterprise Linux、CentOS、または Fedora と同じインストーラーを使用する Red Hat Enterprise Virtualization Hypervisor (RHEV-H) の新しい実装です。RHVH とレガシー RHEV-H の主な違いは、RHVH には書き込み可能なファイルシステムがあり、レガシー RHEV-H のように Manager が RPM をプッシュするのではなく、独自のインストールを処理することです。

7.133.2. rhev_h
リンクのコピー

ホストには、Red Hat Enterprise Linux、CentOS、または Fedora の小規模バージョンである Red Hat Enterprise Virtualization Hypervisor (RHEV-H) が含まれており、仮想マシンをホストするためだけに使用されます。

Vintage Node はサポートされなくなり、非推奨となったため、このプロパティーは関連しなくなりました。

7.134. HostedEngine 構造体
リンクのコピー

Expand

表7.182 属性の概要
名前	型	Summary
`active`	ブール値
`configured`	ブール値
`global_maintenance`	ブール値
`local_maintenance`	ブール値
`score`	Integer

7.135. Icon 構造体
リンクのコピー

仮想マシンまたはテンプレートのアイコン。

Expand

表7.183 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`data`	String	アイコンファイルの Base64 エンコードコンテンツ。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`media_type`	String	アイコンファイルのフォーマット。
`name`	String	人間が判読できるプレーンテキストでの名前。

7.135.1. media_type
リンクのコピー

アイコンファイルのフォーマット。

以下のいずれかになります。

image/jpeg
image/png
image/gif

7.136. Identified 構造体
リンクのコピー

このインターフェイスは、識別子を持つオブジェクトを表すすべてのタイプの基本モデルです。

Expand

表7.184 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

7.137. Image 構造体
リンクのコピー

イメージエンティティーを表します。

Expand

表7.185 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`size`	Integer	イメージファイルのサイズ。
`type`	ImageFileType	イメージファイルのタイプ。

Expand

表7.186 リンクの概要
名前	型	Summary
`storage_domain`	StorageDomain	このイメージに関連付けられたストレージドメイン。

7.138. ImageFileType enum
リンクのコピー

イメージのファイルタイプを表します。

Expand

表7.187 値の概要
名前	Summary
`disk`	イメージは、仮想マシンのディスクとして使用できるディスクフォーマットです。
`floppy`	イメージは、たとえば Windows に VirtIO ドライバーをインストールするために、仮想マシンに接続できるフロッピーディスクです。
`iso`	イメージは ` です。

7.138.1. iso
リンクのコピー

イメージは、仮想マシンを起動およびインストールするための CD-ROM として使用できる .iso ファイルです。

7.139. ImageTransfer 構造体
リンクのコピー

このタイプには、実行中のイメージ転送に関する情報が含まれます。

Expand

表7.188 属性の概要
名前	型	Summary
`active`	ブール値	この転送に少なくとも 1 つのアクティブなセッションがあるかどうかを示します。つまり、クライアントとデーモンの間に少なくとも 1 つのライブ転送セッションがあるかどうかを示します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`direction`	ImageTransferDirection	方向は、転送がイメージデータの送信 (`upload`) であるか、イメージデータの受信 (`download`) であるかを示します。
`format`	DiskFormat	アップロード中に送信された、またはダウンロード中に受信されたデータの形式。
`id`	String	一意の ID
`inactivity_timeout`	Integer	クライアントが非アクティブの場合のタイムアウト (秒単位) で、これを過ぎると Red Hat Virtualization Manager によって転送が中止されます。
`name`	String	人間が判読できるプレーンテキストでの名前。
`phase`	ImageTransferPhase	進行中のイメージ転送の現在のフェーズ。
`proxy_url`	String	ユーザーが入力または出力するプロキシーサーバーの URL。
`shallow`	ブール値	イメージチェーン全体ではなく、指定されたイメージのみをダウンロードします。
`timeout_policy`	ImageTransferTimeoutPolicy	タイムアウトポリシーは、クライアントが inactivityTimeout を超えてアイドル状態になっている場合に、システムが転送を処理する方法を決定します。
`transfer_url`	String	ユーザーが直接入力または出力できるデーモンサーバーの URL。
`transferred`	Integer	転送されたバイト数を示します。

7.139.1. direction
リンクのコピー

方向は、転送がイメージデータの送信 (upload) であるか、イメージデータの受信 (download) であるかを示します。

新しい転送の追加時に方向が設定されていない場合、デフォルトの転送方向は upload になります。

7.139.2. format
リンクのコピー

アップロード中に送信された、またはダウンロード中に受信されたデータの形式。指定しない場合、デフォルトでディスクの形式になります。

7.139.3. inactivity_timeout
リンクのコピー

クライアントが非アクティブの場合のタイムアウト (秒単位) で、これを過ぎると Red Hat Virtualization Manager によって転送が中止されます。非アクティブタイムアウトを無効にするには、'0' を指定します。指定されていない場合は、値はデフォルトで engine-config 値 (value: TransferImageClientInactivityTimeoutInSeconds) になります。

7.139.4. phase
リンクのコピー

進行中のイメージ転送の現在のフェーズ。各転送には、管理されたセッションが必要です。このセッションは、ユーザーがイメージを入力または出力するために開かれている必要があります。詳細は、イメージ転送を参照してください。

7.139.5. proxy_url
リンクのコピー

ユーザーが入力または出力するプロキシーサーバーの URL。この属性は、イメージ転送が転送フェーズにある場合にのみ使用できます。詳細は、phase を参照してください。

7.139.6. shallow
リンクのコピー

イメージチェーン全体ではなく、指定されたイメージのみをダウンロードします。

true の場合、format="raw" および direction="download" を使用すると、転送には指定されたディスクスナップショットからのデータのみが含まれ、未割り当て領域はホールとして報告されます。デフォルトでは、転送にはすべてのディスクスナップショットからのデータが含まれます。

ディスクスナップショットを指定すると、指定したディスクスナップショットのデータのみが転送に含まれます。ディスクを指定すると、アクティブなディスクスナップホストからのデータのみが転送に含まれます。

このパラメーターは、format="raw" を使用していない場合、または direction="upload" の場合は効果がありません。

例: 単一のスナップショットをダウンロードする場合:

<image_transfer>
  <snapshot id="2fb24fa2-a5db-446b-b733-4654661cd56d"/>
  <direction>download</direction>
  <format>raw</format>
  <shallow>true</shallow>
</image_transfer>

<image_transfer>
  <snapshot id="2fb24fa2-a5db-446b-b733-4654661cd56d"/>
  <direction>download</direction>
  <format>raw</format>
  <shallow>true</shallow>
</image_transfer>

Copy to Clipboard

Toggle word wrap

アクティブなスナップショットディスクイメージ (ディスクスナップショットとしてアクセスできない) をダウンロードするには、ディスクを指定します。

<image_transfer>
  <disk id="ff6be46d-ef5d-41d6-835c-4a68e8956b00"/>
  <direction>download</direction>
  <format>raw</format>
  <shallow>true</shallow>
</image_transfer>

<image_transfer>
  <disk id="ff6be46d-ef5d-41d6-835c-4a68e8956b00"/>
  <direction>download</direction>
  <format>raw</format>
  <shallow>true</shallow>
</image_transfer>

Copy to Clipboard

Toggle word wrap

どちらの場合も、imageio クライアントを使用して qcow2 イメージをダウンロードできるようになりました。

from ovirt_imageio import client

client.download(
  transfer.transfer_url,
  "51275e7d-42e9-491f-9d65-b9211c897eac",
  backing_file="07c0ccac-0845-4665-9097-d0a3b16cf43b",
  backing_format="qcow2")

from ovirt_imageio import client

client.download(
  transfer.transfer_url,
  "51275e7d-42e9-491f-9d65-b9211c897eac",
  backing_file="07c0ccac-0845-4665-9097-d0a3b16cf43b",
  backing_format="qcow2")

Copy to Clipboard

Toggle word wrap

7.139.7. transfer_url
リンクのコピー

ユーザーが直接入力または出力できるデーモンサーバーの URL。

これは、proxy_url の代わりになります。つまり、クライアントがホストマシンにアクセスできる場合、プロキシーをバイパスしてホストに直接転送することができ、スループットパフォーマンスが向上する可能性があります。この属性は、イメージ転送が転送フェーズにある場合にのみ使用できます。詳細は、phase を参照してください。

Expand

表7.189 リンクの概要
名前	型	Summary
`backup`	バックアップ	イメージ転送に関連付けられたバックアップ。
`disk`	ディスク	入力または出力の対象となるディスク。
`host`	ホスト	入力または出力の対象となるイメージへの書き込みに使用されるホスト。
`image`	Image	入力または出力の対象となるイメージ。
`snapshot`	DiskSnapshot	入力または出力の対象となるディスクスナップショット。

7.139.8. backup
リンクのコピー

イメージ転送に関連付けられたバックアップ。バックアップの一部であるディスクのイメージ転送を開始するときに指定します。

7.139.9. host
リンクのコピー

入力または出力の対象となるイメージへの書き込みに使用されるホスト。指定されていない場合は、アクティブなホストがデータセンターからランダムに選択されます。

7.139.10. image
リンクのコピー

入力または出力の対象となるイメージ。

重要

この属性は、エンジンのバージョン 4.2 以降で非推奨になりました。代わりに、disk または snapshot の属性を使用してください。

7.140. ImageTransferDirection enum
リンクのコピー

転送時のイメージ転送方向。

新しい転送を追加する場合、ユーザーは ImageTransferDirection としてupload を選択してイメージに転送するか、download を選択してイメージから転送するか選択できます。

詳細は、イメージ転送を参照してください。

Expand

表7.190 値の概要
名前	Summary
`ダウンロード`	イメージからデータをストリーミングする場合、ユーザーは `download` を択する必要があります。
`upload`	ユーザーは、イメージにデータをストリームしたいときに、`upload` を選択することができます。

7.141. ImageTransferPhase enum
リンクのコピー

イメージ転送エンティティーのフェーズのリスト。これらの値はそれぞれ、転送フローの特定のポイントを定義します。

詳細は、イメージ転送を参照してください。

Expand

表7.191 値の概要
名前	Summary
`cancelled`	このフェーズは、ユーザーが転送をキャンセルした結果として設定されます。
`cancelled_system`	このフェーズは、システムが転送をキャンセルした結果として設定されます。
`cancelled_user`	このフェーズは、ユーザーが転送をキャンセルした結果として設定されます。
`finalizing_cleanup`	このフェーズは、ユーザーが転送をキャンセルし、必要なクリーンアップが行われていることを示します。
`finalizing_failure`	このフェーズは、管理ポータルでのみ設定でき、転送中にエラーが発生し、失敗してファイナライズされていることを示します。
`finalizing_success`	このフェーズは、ユーザーが finalize を呼び出したときに設定されます。
`finished_cleanup`	このフェーズは、ユーザーが転送をキャンセルし、必要なクリーンアップが行われたことを示します。
`finished_failure`	対象のイメージが検証に失敗し、使用できないことを示します。
`finished_success`	転送セッションが正常に終了し、対象のイメージが検証されて使用できる状態になったことを示します。
`initializing`	イメージ転送の初期段階。
`paused_system`	このフェーズは、セッションがタイムアウトしたか、この転送で他のエラー (例: 選択したホストで ovirt-imageio が実行されていない) が発生したことを意味します。
`paused_user`	このフェーズは、ユーザーが pause を使用して一時停止を呼び出した結果です。
`resuming`	クライアントが resume を呼び出して転送が再開されたフェーズ。
`transferring`	転送セッションが開始され、クライアントが任意のツールを使用して目的のイメージを入力または出力できるフェーズ。
`unknown`	未知のフェーズ。

7.141.1. cancelled
リンクのコピー

このフェーズは、ユーザーが転送をキャンセルした結果として設定されます。キャンセルは、管理ポータルでのみ実行できます。

7.141.2. finalizing_success
リンクのコピー

このフェーズは、ユーザーが finalize を呼び出したときに設定されます。転送セッションを終了し、対象のイメージの使用を終了するには、finalize の呼び出しが不可欠です。ファイナライズ後、フェーズは finished_success または finished_failure に変更されます。

詳細は、イメージ転送を参照してください。

7.141.3. finished_failure
リンクのコピー

対象のイメージが検証に失敗し、使用できないことを示します。このフェーズに達すると、イメージ転送エンティティーが削除され、対象のイメージが illegal に設定されます。システムが転送をキャンセルした場合も同様です。

7.141.4. finished_success
リンクのコピー

転送セッションが正常に終了し、対象のイメージが検証されて使用できる状態になったことを示します。このフェーズに到達すると、イメージ転送エンティティーは削除されます。

7.141.5. initializing
リンクのコピー

イメージ転送の初期段階。転送セッションの確立中に設定されます。セッションが確立されると、フェーズが transferring に変更されます

7.141.6. paused_system
リンクのコピー

このフェーズは、セッションがタイムアウトしたか、この転送で他のエラー (例: 選択したホストで ovirt-imageio が実行されていない) が発生したことを意味します。セッションを再開するには、クライアントは resume を呼び出す必要があります。再開後、フェーズは resuming に切り替わります。

7.141.7. resuming
リンクのコピー

クライアントが resume を呼び出して転送が再開されたフェーズ。再開すると新しいセッションが開始され、呼び出した後、フェーズは transferring、失敗した場合は paused_system に変更されます。

7.141.8. unknown
リンクのコピー

未知のフェーズ。これは、予期しないエラーが発生した場合にのみ設定されます。

7.142. ImageTransferTimeoutPolicy enum
リンクのコピー

イメージ転送のタイムアウトポリシー。

クライアントが inactivityTimeout (秒) の間非アクティブな場合に、システムが転送を処理する方法を定義します。

詳細は、イメージ転送を参照してください。

Expand

表7.192 値の概要
名前	Summary
`cancel`	転送をキャンセルし、ディスクのロックを解除します。
`legacy`	LEGACY ポリシーは、デフォルトであるレガシー機能を保持します。
`pause`	転送を一時停止します。

7.142.1. cancel
リンクのコピー

転送をキャンセルし、ディスクのロックを解除します。アップロード方向を使用したイメージ転送の場合、ディスクは削除されます。

7.142.2. legacy
リンクのコピー

LEGACY ポリシーは、デフォルトであるレガシー機能を保持します。デフォルトの動作では、方向がダウンロードの場合は転送がキャンセルされ、アップロードの場合は一時停止されます。

7.142.3. pause
リンクのコピー

転送を一時停止します。ユーザーは、転送を再開またはキャンセルできます。転送が一時停止されている間、ディスクはロックされたままになります。

7.143. InheritableBoolean enum
リンクのコピー

設定するか、上位レベルから継承できるブール値を表す enum。継承順は仮想マシン → クラスター → engine-config です。

Expand

表7.193 値の概要
名前	Summary
`false`	このレベルで値を false に設定します。
`inherit`	上位レベルから値を継承します。
`true`	このレベルで値を true に設定します。

7.144. Initialization 構造体
リンクのコピー

Expand

表7.194 属性の概要
名前	型	Summary
`active_directory_ou`	String
`authorized_ssh_keys`	String
`cloud_init`	CloudInit	cloud-init 設定を指定する非推奨の属性。
`cloud_init_network_protocol`	CloudInitNetworkProtocol	cloud-init ネットワークパラメーターのフォーマットに使用する cloud-init プロトコルを指定する属性。
`configuration`	設定
`custom_script`	String
`dns_search`	String
`dns_servers`	String
`domain`	String
`host_name`	String
`input_locale`	String
`nic_configurations`	NicConfiguration[]
`org_name`	String
`regenerate_ids`	ブール値
`regenerate_ssh_keys`	ブール値
`root_password`	String
`system_locale`	String
`timezone`	String
`ui_language`	String
`user_locale`	String
`user_name`	String
`windows_license_key`	String

7.144.1. cloud_init
リンクのコピー

cloud-init 設定を指定する非推奨の属性。

この属性と CloudInit タイプは非推奨となっており、今後削除される予定です。cloud-init 設定を指定するには、Initialization タイプ内の属性を使用します。これら 2 つのタイプの属性間のマッピングは次のとおりです。

Expand

CloudInit	初期化
`authorized_keys`	`authorized_ssh_keys`
`dns.search_domains`	`dns_search`
`dns.servers`	`dns_servers`
`files`	`custom_script`
`host`	`host_name`
`network_configuration.nics`	`nic_configurations`
`regenerate_ssh_keys`	`regenerate_ssh_keys`
`timezone`	`timezone`
`ユーザー`	`user_name` & `root_password`

cloud-init の使い方の詳細は、Python と Java の例を参照してください。

7.144.2. cloud_init_network_protocol
リンクのコピー

cloud-init ネットワークパラメーターのフォーマットに使用する cloud-init プロトコルを指定する属性。省略した場合、CloudInitNetworkProtocol で説明されているように、デフォルト値が使用されます。

7.145. InstanceType 構造体
リンクのコピー

仮想マシンのハードウェア設定を説明します。

たとえば、medium インスタンスタイプには、1 つの仮想 CPU と 4GiB のメモリーが含まれています。これは最上位のエンティティーです (たとえば、データセンターやクラスターにバインドされていません)。インスタンスタイプに使用され、仮想マシンおよびテンプレートタイプに共通する属性は次のとおりです。

console
cpu
custom_cpu_model
custom_emulated_machine
display
high_availability
io
memory
memory_policy
migration
migration_downtime
os
rng_device
soundcard_enabled
usb
virtio_scsi

インスタンスタイプとテンプレートの両方から仮想マシンを作成する場合、仮想マシンはインスタンスタイプからハードウェア設定を継承します。

注記

ほとんどのテンプレート属性はインスタンスタイプでは使用されませんが、インスタンスタイプはその属性をテンプレートエンティティーから継承します。

Expand

表7.195 属性の概要
名前	型	Summary
`auto_pinning_policy`	AutoPinningPolicy	自動 CPU および NUMA 設定を適用するかどうか、およびその適用方法を指定します。
`bios`	Bios	仮想マシンの BIOS 設定への参照。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`console`	Console	この仮想マシン用に設定されたコンソール。
`cpu`	Cpu	仮想マシン CPU の設定。
`cpu_pinning_policy`	CpuPinningPolicy	CPU および NUMA 設定を適用するかどうか、またどのように適用するかを指定します。
`cpu_shares`	Integer
`creation_time`	日付	仮想マシンの作成日。
`custom_compatibility_version`	バージョン	仮想マシンのカスタム互換性バージョン。
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	さまざまなフックを設定するために VDSM に送信されるプロパティー。
`delete_protected`	ブール値	`true` の場合、仮想マシンは削除できません。
`description`	String	プレーンテキストでの人間が判読できる説明。
`display`	表示	仮想マシンの表示設定。
`domain`	ドメイン	この仮想マシン用に設定されたドメイン。
`high_availability`	高可用性	仮想マシンの高可用性設定。
`id`	String	一意の ID
`initialization`	初期化	仮想マシンの初期化設定への参照。
`io`	Io	IO スレッドのパフォーマンスチューニング用。
`large_icon`	アイコン	仮想マシンの大きなアイコン。
`lease`	StorageDomainLease	この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。
`memory`	Integer	仮想マシンのメモリー (バイト単位)。
`memory_policy`	MemoryPolicy	仮想マシンのメモリー管理設定への参照。
`migration`	MigrationOptions	実行中の仮想マシンの別のホストへの移行設定への参照。
`migration_downtime`	Integer	別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。
`multi_queues_enabled`	ブール値	`true` の場合、各仮想インターフェイスは、利用可能な仮想 CPU に応じて最適な数のキューを取得します。
`name`	String	人間が判読できるプレーンテキストでの名前。
`origin`	String	この仮想マシンのオリジン。
`os`	OperatingSystem	仮想マシンにインストールされているオペレーティングシステムのタイプ。
`placement_policy`	VmPlacementPolicy	仮想マシンの配置ポリシーの設定。
`rng_device`	RngDevice	この仮想マシンの乱数ジェネレーターデバイスの設定。
`serial_number`	SerialNumber	クラスター内の仮想マシンのシリアル番号。
`small_icon`	アイコン	仮想マシンの小さなアイコン。
`soundcard_enabled`	ブール値	`true` の場合、サウンドカードが仮想マシンに追加されます。
`sso`	Sso	この仮想マシンが設定されているシングルサインオン設定への参照。
`start_paused`	ブール値	`true` の場合、仮想マシンは起動後、最初は 'paused' 状態になります。
`stateless`	ブール値	`true` の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。
`status`	TemplateStatus	テンプレートのステータス。
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	ストレージエラー後に仮想マシンを再開する方法を決定します。
`time_zone`	TimeZone	oVirt によって設定された仮想マシンのタイムゾーン。
`tpm_enabled`	ブール値	`true` の場合、TPM デバイスが仮想マシンに追加されます。
`tunnel_migration`	ブール値	`true` の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。
`type`	VmType	仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。
`usb`	Usb	この仮想マシンの USB デバイスの設定 (カウント、タイプ)。
`version`	TemplateVersion	これが別のテンプレートのベースバージョンであるかサブバージョンであるかを示します。
`virtio_scsi`	VirtioScsi	VirtIO SCSI 設定への参照。
`virtio_scsi_multi_queues`	Integer	このフィールドの Virtio-SCSI contoller のキュー数には virtioScsiMultiQueuesEnabled が true である必要があります。詳細は virtioScsiMultiQueuesEnabled を参照してください。
`virtio_scsi_multi_queues_enabled`	ブール値	`true` の場合、Virtio-SCSI デバイスは、使用可能な仮想 CPU とディスク、または指定された virtioScsiMultiQueues に応じて、いくつかの複数キューを取得します。
`vm`	Vm	このテンプレートに関連付けられている仮想マシンの設定。

7.145.1. auto_pinning_policy
リンクのコピー

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

重要

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

7.145.2. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

Copy to Clipboard

Toggle word wrap

7.145.3. cpu_pinning_policy
リンクのコピー

CPU および NUMA 設定を適用するかどうか、またどのように適用するかを指定します。指定されていない場合、CPU ピニング文字列の以前の動作により、CpuPinningPolicy が None または Manual に決定されます。

7.145.4. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

仮想マシンを独自の互換性バージョンにカスタマイズできるようにします。custom_compatibility_version が設定されている場合、この特定の仮想マシンのクラスター互換性バージョンをオーバーライドします。

仮想マシンの互換バージョンは、仮想マシンが格納されているデータセンターによって制限され、仮想マシンが実行される予定のホストの機能に対してチェックされます。

7.145.5. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

7.145.6. initialization
リンクのコピー

仮想マシンの初期化設定への参照。

注記

Red Hat Virtualization 4.1.8 以降、このプロパティーは空のタグを送信することでクリアできます。

たとえば、initialization 属性をクリアするには、次のようなリクエストを送ります。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <initialization/>
</vm>

<vm>
  <initialization/>
</vm>

Copy to Clipboard

Toggle word wrap

このようなリクエストへのレスポンス、およびヘッダー All-Content: true を持つリクエストには、引き続きこの属性が含まれます。

7.145.7. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.145.8. lease
リンクのコピー

この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。

リースを使用して実行している仮想マシンは、この仮想マシンの別のインスタンスが別のホストで実行されるのを防ぐために、実行中にリースが別のホストによって取得されていないことを確認する必要があります。これにより、高可用性の仮想マシンでスプリットブレインが保護されます。このテンプレートから作成された仮想マシンを、このストレージドメインをリースの場所として事前設定するために、テンプレートにリース用に定義されたストレージドメインを含めることもできます。

7.145.9. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>

<vm>
  <memory>1073741824</memory>
</vm>

Copy to Clipboard

Toggle word wrap

メモリーホットプラグは、Red Hat Virtualization 3.6 以降でサポートされています。上記の例を使用して、仮想マシンが up 状態のときにメモリーを増やすことができます。サイズの増分は、HotPlugMemoryBlockSizeMb 設定値 (デフォルトでは 256 MiB) の値で割り切れる必要があります。メモリーサイズの増分がこの値で割り切れない場合、メモリーサイズの変更は次の実行設定にのみ保存されます。メモリーのホットプラグ操作が成功するたびに、1 つまたは 2 つの新しいメモリーデバイスが作成されます。

メモリーのホットアンプラグは、Red Hat Virtualization 4.2 以降でサポートされています。メモリーのホットアンプラグは、仮想マシンの状態が up の場合にのみ実行できます。ホットアンプラグ操作で取り外すことができるのは、以前にホットプラグされたメモリーデバイスのみです。要求されたメモリーの減少分は、以前にホットプラグされたメモリーデバイスの組み合わせのサイズに一致するように切り捨てられます。要求されたメモリー値は、丸められずに次の実行設定に格納されます。

注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 2³⁰ バイト = 1073741824 バイト。

注記

Red Hat Virtualization Manager は内部的に値を切り捨てて整数の MiB (1MiB = 2²⁰ バイト) にします。

7.145.10. migration
リンクのコピー

実行中の仮想マシンの別のホストへの移行設定への参照。

注記

7.145.11. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

7.145.12. origin
リンクのコピー

この仮想マシンのオリジン。

値:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.145.13. placement_policy
リンクのコピー

仮想マシンの配置ポリシーの設定。

この設定を更新して、仮想マシンを 1 つ以上のホストにピニングできます。

注記

複数のホストにピニングされた仮想マシンはライブマイグレーションできませんが、ホストに障害が発生した場合、高可用性になるように設定された仮想マシンは、仮想マシンがピニングされている他のホストの 1 つで自動的に再起動されます。

たとえば、仮想マシンを 2 つのホストに固定するには、以下のリクエストを送信します。

PUT /api/vms/123

PUT /api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

Copy to Clipboard

Toggle word wrap

7.145.14. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.145.15. sso
リンクのコピー

この仮想マシンが設定されているシングルサインオン設定への参照。コンソールを開くと、ユーザーは仮想マシンのオペレーティングシステムに自動的にサインインできます。

7.145.16. tpm_enabled
リンクのコピー

true の場合、TPM デバイスが仮想マシンに追加されます。デフォルト値は false です。このプロパティーは、"All-Content=true" ヘッダーが設定されている場合に、フェッチするときにのみ表示されます。

Expand

表7.196 リンクの概要
名前	型	Summary
`cdroms`	Cdrom[]	テンプレートに接続された CD-ROM デバイスへの参照。
`cluster`	クラスター	仮想マシンが属するクラスターへの参照。
`cpu_profile`	CpuProfile	この仮想マシンによって使用される CPU プロファイルへの参照。
`disk_attachments`	DiskAttachment[]	テンプレートに割り当てられたディスクへの参照。
`graphics_consoles`	GraphicsConsole[]	テンプレートに接続されたグラフィックコンソールへの参照。
`mediated_devices`	VmMediatedDevice[]	仲介デバイスの設定。
`nics`	Nic[]	テンプレートにアタッチされたネットワークインターフェイスへの参照。
`permissions`	Permission[]	テンプレートに割り当てられたユーザーパーミッションへの参照。
`quota`	クォータ	この仮想マシンに設定されたクォータ設定への参照。
`storage_domain`	StorageDomain	仮想マシンが属するストレージドメインへの参照。
`tags`	Tag[]	テンプレートにアタッチされたタグへの参照。
`watchdogs`	Watchdog[]	テンプレートにアタッチされたウォッチドッグデバイスへの参照。

7.146. Io 構造体
リンクのコピー

Expand

表7.197 属性の概要
名前	型	Summary
`threads`	Integer

7.147. Ip 構造体
リンクのコピー

ネットワークインターフェイスの IP 設定を表します。

Expand

表7.198 属性の概要
名前	型	Summary
`address`	String	IP アドレスのテキスト表現。
`gateway`	String	デフォルトゲートウェイのアドレス。
`netmask`	String	ネットワークマスク。
`version`	IpVersion	IP プロトコルのバージョン。

7.147.1. address
リンクのコピー

IP アドレスのテキスト表現。

たとえば、IPv4 アドレスは以下のように表現されます。

<ip>
  <address>192.168.0.1</address>
  ...
</ip>

<ip>
  <address>192.168.0.1</address>
  ...
</ip>

Copy to Clipboard

Toggle word wrap

IPv6 アドレスは次のように表されます。

<ip>
  <address>2620:52:0:20f0:4216:7eff:feaa:1b50</address>
  ...
</ip>

<ip>
  <address>2620:52:0:20f0:4216:7eff:feaa:1b50</address>
  ...
</ip>

Copy to Clipboard

Toggle word wrap

7.147.2. netmask
リンクのコピー

ネットワークマスク。

IPv6 アドレスの場合、値は 0-128 の範囲の整数で、サブネット接頭辞を表します。

7.147.3. version
リンクのコピー

IP プロトコルのバージョン。

注記

Manager のバージョン 4.1 から、この属性はオプションになり、値が指定されていない場合は、address 属性の値から推測されます。

7.148. IpAddressAssignment struct
リンクのコピー

ネットワークデバイスの IP アドレスの割り当てを表します。

静的ブートプロトコル割り当てを行うには、IP 設定でサブネットマスクと IP アドレス (およびオプションでデフォルトゲートウェイ) を指定する必要があります。

Expand

表7.199 属性の概要
名前	型	Summary
`assignment_method`	BootProtocol	ネットワークデバイスの IP 設定の割り当てに使用されるブートプロトコルを設定します。
`ip`	Ip	ネットワークデバイスの IP 設定を設定します。

7.149. IpVersion enum
リンクのコピー

IP プロトコルバージョンの値を定義します。

Expand

表7.200 値の概要
名前	Summary
`v4`	IPv4。
`v6`	IPv6。

7.150. IscsiBond struct
リンクのコピー

Expand

表7.201 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.202 リンクの概要
名前	型	Summary
`data_center`	DataCenter
`networks`	Network[]
`storage_connections`	StorageConnection[]

7.151. IscsiDetails struct
リンクのコピー

Expand

表7.203 属性の概要
名前	型	Summary
`address`	String
`disk_id`	String
`initiator`	String
`lun_mapping`	Integer
`password`	String
`paths`	Integer
`port`	Integer
`portal`	String
`product_id`	String
`serial`	String
`size`	Integer
`status`	String
`storage_domain_id`	String
`target`	String
`username`	String
`vendor_id`	String
`volume_group_id`	String

7.152. Job 構造体
リンクのコピー

システム内のフローの実行を監視するジョブを表します。ジョブには、階層構造の複数のステップを含めることができます。ステップは並行して処理できますが、フローの実装によって異なります。

Expand

表7.204 属性の概要
名前	型	Summary
`auto_cleared`	ブール値	システムによってジョブが完了した後、ジョブが自動的にクリアされるかどうかを示します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`end_time`	日付	ジョブの終了時刻。
`external`	ブール値	ジョブが外部システムによって開始されたかどうかを示します。
`id`	String	一意の ID
`last_updated`	日付	ジョブの最終更新日。
`name`	String	人間が判読できるプレーンテキストでの名前。
`start_time`	日付	ジョブの開始時刻。
`status`	JobStatus	ジョブのステータス。

7.152.1. external
リンクのコピー

ジョブが外部システムによって開始されたかどうかを示します。外部ジョブは、ジョブの作成者によって外部で管理されます。

Expand

表7.205 リンクの概要
名前	型	Summary
`owner`	User	ジョブの所有者であるユーザー。
`steps`	Step[]	ジョブのステップ。

7.153. JobStatus enum
リンクのコピー

ステップのステータスを表します。

Expand

表7.206 値の概要
名前	Summary
`aborted`	中止されたジョブのステータス。
`failed`	失敗したジョブのステータス。
`finished`	終了したジョブのステータス。
`started`	開始されたジョブのステータス。
`unknown`	不明なジョブのステータス。

7.153.1. aborted
リンクのコピー

中止されたジョブのステータス。このステータスは、強制的に中止された外部ジョブに適用されます。

7.153.2. finished
リンクのコピー

終了したジョブのステータス。このステータスは、ジョブの実行が完了したことを示します。

7.153.3. started
リンクのコピー

開始されたジョブのステータス。このステータスは、現在実行中のジョブを表します。

7.153.4. unknown
リンクのコピー

不明なジョブのステータス。このステータスは、解決方法が不明なジョブ、つまり、システムが予期せず再起動される前に実行されたジョブを表します。

7.154. KatelloErratum struct
リンクのコピー

Katello erratum を表すタイプ。

Expand

表7.207 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`issued`	日付	Katello エラータが発行された日付。
`name`	String	人間が判読できるプレーンテキストでの名前。
`packages`	Package[]	Katello エラータによって報告された問題を解決するパッケージのリスト。
`severity`	String	Katello エラータの重大度。
`solution`	String	Katello エラータで記述されている問題のソリューション。
`summary`	String	Katello エラータの要約。
`title`	String	Katello エラータのタイトル。
`type`	String	Katello エラータのタイプ。

7.154.1. severity
リンクのコピー

Katello エラータの重大度。

サポートされる重要度は、moderate、important、critical です。

7.154.2. type
リンクのコピー

Katello エラータのタイプ。

サポートされるタイプは、bugfix、enhancement、security です。

Expand

表7.208 リンクの概要
名前	型	Summary
`host`	ホスト	Katello エラータが割り当てられているホストへの参照。
`vm`	Vm	Katello エラータが割り当てられている仮想マシンへの参照。

7.155. KdumpStatus enum
リンクのコピー

Expand

表7.209 値の概要
名前	Summary
`disabled`
`enabled`
`unknown`

7.156. Kernel 構造体
リンクのコピー

Expand

表7.210 属性の概要
名前	型	Summary
`version`	バージョン

7.157. Ksm 構造体
リンクのコピー

Expand

表7.211 属性の概要
名前	型	Summary
`enabled`	ブール値
`merge_across_nodes`	ブール値

7.158. LinkLayerDiscoveryProtocolElement struct
リンクのコピー

Link Layer Discovery Protocol (LLDP) によって受信された情報要素を表します。IEEE 802.1AB は、タイプ、長さ、値 (TLV) を「情報要素の短い可変長エンコーディング」と定義しています。このタイプは、そのような情報要素を表します。

属性 name は、値の内容を説明するために使用される人間が判読できる文字列であり、一意ではない場合があります。type とオプションの oui および subtype から作成できるため、この名前は冗長です。name の目的は、情報要素の読み取りを簡略化することです。プロパティーの name は、IEEE 802.1AB の第 8 章で使用されている文字列とまったく同じです。

組織固有の情報要素には、127 の typeと、oui および subtype の属性があります。

たとえば、情報要素の XML 表現は次のようになります。

<link_layer_discovery_protocol_element>
  <name>Port VLAN Id</name>
  <oui>32962</oui>
  <properties>
    <property>
      <name>vlan id</name>
      <value>488</value>
    </property>
    <property>
      <name>vlan name</name>
      <value>v2-0488-03-0505</value>
    </property>
  </properties>
  <subtype>3</subtype>
  <type>127</type>
</link_layer_discovery_protocol_element>

<link_layer_discovery_protocol_element>
  <name>Port VLAN Id</name>
  <oui>32962</oui>
  <properties>
    <property>
      <name>vlan id</name>
      <value>488</value>
    </property>
    <property>
      <name>vlan name</name>
      <value>v2-0488-03-0505</value>
    </property>
  </properties>
  <subtype>3</subtype>
  <type>127</type>
</link_layer_discovery_protocol_element>

Copy to Clipboard

Toggle word wrap

Expand

表7.212 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`oui`	Integer	整数としてエンコードされた組織固有識別子 (OUI)。
`properties`	Property[]	情報要素によって転送される構造化データを、名前と値のペアのリストとして表します。
`subtype`	Integer	整数としてエンコードされた組織的に定義されたサブタイプ。
`type`	Integer	整数としてエンコードされた LinkLayerDiscoveryProtocolElement のタイプ。

7.158.1. oui
リンクのコピー

整数としてエンコードされた組織固有識別子 (OUI)。type が 127 の場合のみ有効です。

7.158.2. subtype
リンクのコピー

整数としてエンコードされた組織的に定義されたサブタイプ。type が 127 の場合のみ有効です。

7.159. LogMaxMemoryUsedThresholdType enum
リンクのコピー

システムでサポートされているすべての最大メモリーしきい値タイプを説明します。

Expand

表7.213 値の概要
名前	Summary
`absolute_value_in_mb`	絶対値でのしきい値タイプ。
`percentage`	パーセンテージでのしきい値タイプ。

7.159.1. absolute_value_in_mb
リンクのコピー

絶対値でのしきい値タイプ。

絶対値を指定すると、MB 単位の空きメモリーが LogMaxMemoryUsedThreshold で指定された値を下回ると、監査ログイベントがログに記録されます。

7.159.2. percentage
リンクのコピー

パーセンテージでのしきい値タイプ。

パーセンテージを指定すると、使用されているメモリーが LogMaxMemoryUsedThreshold で指定された値を超えると、監査ログイベントがログに記録されます。

7.160. LogSeverity enum
リンクのコピー

イベントの重大度を表す列挙型。

Expand

表7.214 値の概要
名前	Summary
`alert`	アラートの重大度。
`error`	エラーの重大度。
`normal`	通常の重大度。
`warning`	警告の重大度。

7.160.1. alert
リンクのコピー

アラートの重大度。すぐに対処する必要がある状態を指定するために使用されます。

7.160.2. error
リンクのコピー

エラーの重大度。調査が必要なエラーがあることを指定するために使用されます。

7.160.3. normal
リンクのコピー

通常の重大度。情報イベントに使用されます。

7.160.4. warning
リンクのコピー

警告の重大度。何かが間違っている可能性があることを警告するために使用されます。

7.161. LogicalUnit 構造体
リンクのコピー

Expand

表7.215 属性の概要
名前	型	Summary
`address`	String
`discard_max_size`	Integer	1 回の操作で論理ユニットの基礎のストレージによって破棄できる最大バイト数。
`discard_zeroes_data`	ブール値	論理ユニットの基礎となるストレージ内の以前に破棄されたブロックがゼロとして読み戻される場合は True。
`disk_id`	String
`id`	String
`lun_mapping`	Integer
`password`	String
`paths`	Integer
`port`	Integer
`portal`	String
`product_id`	String
`serial`	String
`size`	Integer
`status`	LunStatus
`storage_domain_id`	String
`target`	String
`username`	String
`vendor_id`	String
`volume_group_id`	String

7.161.1. discard_max_size
リンクのコピー

1 回の操作で論理ユニットの基礎のストレージによって破棄できる最大バイト数。値 0 は、デバイスが破棄機能をサポートしていないことを意味します。

注記

これは、discard_max_bytes の queue-sysfs ドキュメント記載されているように、ハードウェアの制限ではなく、ソフトウェアの制限です。

7.161.2. discard_zeroes_data
リンクのコピー

論理ユニットの基礎となるストレージ内の以前に破棄されたブロックがゼロとして読み戻される場合は True。詳細は、discard_zeroes_data の queue-sysfs documentation ドキュメントを参照してください。

重要

システムのバージョン 4.2.1 以降、カーネルの sysfs ファイル discard_zeroes_data が非推奨になったため、この属性のサポートが削除されました。後方互換性のために保持されていますが、値は常に false になります。

7.162. LunStatus enum
リンクのコピー

Expand

表7.216 値の概要
名前	Summary
`free`
`unusable`
`used`

7.163. MDevType struct
リンクのコピー

仲介デバイスは、物理デバイスのリソースを分割できるようにするソフトウェアデバイスです。

詳細は Libvirt-MDEV を参照してください。

Expand

表7.217 属性の概要
名前	型	Summary
`available_instances`	Integer	MDev タイプの使用可能なインスタンス数。
`description`	String	MDev タイプの説明。
`human_readable_name`	String	MDev タイプの人間が読める名前。
`name`	String	MDev タイプ名。

7.164. Mac 構造体
リンクのコピー

仮想ネットワークインターフェイスの MAC アドレスを表します。

Expand

表7.218 属性の概要
名前	型	Summary
`address`	String	MAC アドレス

7.165. MacPool 構造体
リンクのコピー

MAC アドレスプールを表します。

MAC アドレスプールの XML 表現の例:

<mac_pool href="/ovirt-engine/api/macpools/123" id="123">
  <name>Default</name>
  <description>Default MAC pool</description>
  <allow_duplicates>false</allow_duplicates>
  <default_pool>true</default_pool>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:E6</to>
    </range>
  </ranges>
</mac_pool>

<mac_pool href="/ovirt-engine/api/macpools/123" id="123">
  <name>Default</name>
  <description>Default MAC pool</description>
  <allow_duplicates>false</allow_duplicates>
  <default_pool>true</default_pool>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:E6</to>
    </range>
  </ranges>
</mac_pool>

Copy to Clipboard

Toggle word wrap

Expand

表7.219 属性の概要
名前	型	Summary
`allow_duplicates`	ブール値	プールで重複する MAC アドレスを許可するかどうかを定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`default_pool`	ブール値	これがデフォルトプールかどうかを定義します。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`ranges`	Range[]	プールの MAC アドレスの範囲を定義します。

7.165.1. allow_duplicates
リンクのコピー

プールで重複する MAC アドレスを許可するかどうかを定義します。指定されていない場合、false にデフォルト設定されます。

7.165.2. default_pool
リンクのコピー

これがデフォルトプールかどうかを定義します。指定されていない場合、false にデフォルト設定されます。

7.165.3. ranges
リンクのコピー

プールの MAC アドレスの範囲を定義します。複数の範囲を定義できます。

Expand

表7.220 リンクの概要
名前	型	Summary
`permissions`	Permission[]	MacPool に関連付けられているパーミッションへの参照を返します。

7.166. MemoryOverCommit struct
リンクのコピー

Expand

表7.221 属性の概要
名前	型	Summary
`percent`	Integer

7.167. MemoryPolicy 構造体
リンクのコピー

仮想マシンのようなエンティティーのメモリー関連プロパティーの論理グループ。

Expand

表7.222 属性の概要
名前	型	Summary
`ballooning`	ブール値
`guaranteed`	Integer	バルーンメカニズムによって排出されないことが保証されているメモリーの量 (バイト単位)。
`max`	Integer	仮想マシンの最大メモリー (バイト単位)。
`over_commit`	MemoryOverCommit
`transparent_huge_pages`	TransparentHugePages

7.167.1. guaranteed
リンクのコピー

バルーンメカニズムによって排出されないことが保証されているメモリーの量 (バイト単位)。

Red Hat Virtualization Manager は、この値を内部的に切り捨てて整数の MiB (1MiB = 2²⁰ バイト) にします。

注記

Red Hat Virtualization 4.2 以降では、同じ要求でメモリーも更新され、仮想マシンの状態が up であれば、仮想マシンの実行中に更新できます。

7.167.2. max
リンクのコピー

仮想マシンの最大メモリー (バイト単位)。

ユーザーは値をバイト単位で指定し、Red Hat Virtualization Manager は値を切り捨てて最も近い下位の MiB 値にします。

たとえば、ユーザーが 1073741825 (1 GiB + 1 byte) という値を入力すると、Red Hat Virtualization Manager はその値を最も近い下位 MiB 境界に切り詰めます。この場合は、1073741824 (1 GiB) になります。

7.168. MessageBrokerType enum
リンクのコピー

非推奨のメッセージブローカータイプ。

Red Hat Virtualization 4.4.0 以降、OpenStack Neutron エージェントのデプロイメントが削除されたため、無視されます。

Expand

表7.223 値の概要
名前	Summary
`qpid`
`rabbit_mq`

7.169. Method 構造体
リンクのコピー

Expand

表7.224 属性の概要
名前	型	Summary
`id`	SsoMethod

7.170. MigrateOnError enum
リンクのコピー

Expand

表7.225 値の概要
名前	Summary
`do_not_migrate`
`migrate`
`migrate_highly_available`

7.171. MigrationBandwidth 構造体
リンクのコピー

移行で使用される帯域幅を定義します。

Expand

表7.226 属性の概要
名前	型	Summary
`assignment_method`	MigrationBandwidthAssignmentMethod	帯域幅を割り当てるのに使用するメソッド。
`custom_value`	Integer	Mbps 単位のカスタム帯域幅。

7.171.1. custom_value
リンクのコピー

Mbps 単位のカスタム帯域幅。assignmentMethod 属性が custom の場合にのみ適用されます。

7.172. MigrationBandwidthAssignmentMethod enum
リンクのコピー

移行帯域幅の割り当て方法を定義します。

Expand

表7.227 値の概要
名前	Summary
`auto`	Quality of Service が定義されている場合、Quality of Service から帯域幅を取得します。
`custom`	カスタム定義の帯域幅 (Mbit/s)。
`hypervisor_default`	ハイパーバイザーで設定された値を取得します。

7.172.1. auto
リンクのコピー

Quality of Service が定義されている場合、Quality of Service から帯域幅を取得します。Quality of Service が定義されていない場合、帯域幅は使用中の検出されたリンク速度から取得されます。何も検出されない場合、帯域幅は hypervisor_default 値に戻ります。

7.173. MigrationOptions 構造体
リンクのコピー

移行オプションのタイプ。

Expand

表7.228 属性の概要
名前	型	Summary
`auto_converge`	InheritableBoolean
`bandwidth`	MigrationBandwidth	移行で使用できる帯域幅。
`compressed`	InheritableBoolean
`custom_parallel_migrations`	Integer	使用する並行移行接続の数を指定します。
`encrypted`	InheritableBoolean	移行を暗号化するかどうかを指定します。
`parallel_migrations_policy`	ParallelMigrationsPolicy	並列移行接続を使用するかどうか、および使用方法を指定します。

7.173.1. custom_parallel_migrations
リンクのコピー

使用する並行移行接続の数を指定します。ParallelMigrationsPolicy が CUSTOM の場合のみ指定できます。有効な値の範囲は 2-255 です。推奨される値の範囲は 2-16 です。

Expand

表7.229 リンクの概要
名前	型	Summary
`policy`	MigrationPolicy	`engine-config` を使用して定義された、移行ポリシーへの参照。

7.174. MigrationPolicy 構造体
リンクのコピー

収束や許可される並列移行の数など、移行の処理方法を説明するポリシー。

Expand

表7.230 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

7.175. Network 構造体
リンクのコピー

論理ネットワークのタイプ。

論理ネットワークの JSON 表現の例:

{
  "network" : [ {
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "stp" : "false",
    "mtu" : "0",
    "usages" : {
      "usage" : [ "vm" ]
    },
    "name" : "ovirtmgmt",
    "description" : "Management Network",
    "href" : "/ovirt-engine/api/networks/456",
    "id" : "456",
    "link" : [ {
      "href" : "/ovirt-engine/api/networks/456/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/networks/456/vnicprofiles",
      "rel" : "vnicprofiles"
    }, {
      "href" : "/ovirt-engine/api/networks/456/labels",
      "rel" : "labels"
    } ]
  } ]
}

{
  "network" : [ {
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "stp" : "false",
    "mtu" : "0",
    "usages" : {
      "usage" : [ "vm" ]
    },
    "name" : "ovirtmgmt",
    "description" : "Management Network",
    "href" : "/ovirt-engine/api/networks/456",
    "id" : "456",
    "link" : [ {
      "href" : "/ovirt-engine/api/networks/456/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/networks/456/vnicprofiles",
      "rel" : "vnicprofiles"
    }, {
      "href" : "/ovirt-engine/api/networks/456/labels",
      "rel" : "labels"
    } ]
  } ]
}

Copy to Clipboard

Toggle word wrap

同じ論理ネットワークの XML 表現の例:

<network href="/ovirt-engine/api/networks/456" id="456">
  <name>ovirtmgmt</name>
  <description>Management Network</description>
  <link href="/ovirt-engine/api/networks/456/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/456/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/456/labels" rel="labels"/>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
  <stp>false</stp>
  <mtu>0</mtu>
  <usages>
    <usage>vm</usage>
  </usages>
</network>

<network href="/ovirt-engine/api/networks/456" id="456">
  <name>ovirtmgmt</name>
  <description>Management Network</description>
  <link href="/ovirt-engine/api/networks/456/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/456/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/456/labels" rel="labels"/>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
  <stp>false</stp>
  <mtu>0</mtu>
  <usages>
    <usage>vm</usage>
  </usages>
</network>

Copy to Clipboard

Toggle word wrap

Expand

表7.231 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`display`	ブール値	非推奨となりました。ネットワークをディスプレイネットワークとして定義するには、'usages' を使用する必要があります。
`dns_resolver_configuration`	DnsResolverConfiguration	GET を使用してネットワークを取得すると、DNS リゾルバーの設定が報告されます。
`id`	String	一意の ID
`ip`	Ip	非推奨 (使用されていません)。
`mtu`	Integer	ネットワークの最大伝送単位を指定します。
`name`	String	人間が判読できるプレーンテキストでの名前。
`port_isolation`	ブール値	同じホストで実行されている VM 間の通信をこのネットワークでブロックするかどうかを定義します。
`profile_required`	ブール値	ネットワークの作成時に仮想ネットワークインターフェイスプロファイルを自動的に作成するかどうかを指定します。
`required`	ブール値	クラスター内のすべてのホストに対して、ネットワークが必須であるかどうかを定義します。
`status`	NetworkStatus	ネットワークのステータス。
`stp`	ブール値	ネットワークでスパニングツリープロトコルが有効かどうかを指定します。
`usages`	NetworkUsage[]	ネットワークの使用要素のセットを定義します。
`vdsm_name`	String	ホストで使用されているネットワークの名前。
`vlan`	Vlan	VLAN タグ。

7.175.1. dns_resolver_configuration
リンクのコピー

GET を使用してネットワークを取得すると、DNS リゾルバーの設定が報告されます。新規にネットワークを作成する場合も、既存のネットワークを更新する場合も、任意で設定することができます。

7.175.2. port_isolation
リンクのコピー

同じホストで実行されている VM 間の通信をこのネットワークでブロックするかどうかを定義します。VM ネットワークにのみ適用されます。複数のホスト間の通信がブロックされていることを確認するのは、ネットワーク管理者の責任です。この属性は、ネットワークの作成時にのみ設定でき、編集することはできません。値が設定されていない場合、同じホストで実行されている VM 間の通信が許可されます。

7.175.3. required
リンクのコピー

クラスター内のすべてのホストに対して、ネットワークが必須であるかどうかを定義します。'required' の operational ネットワークがホストから省略された場合、ホストは non_operational とマークされます。

7.175.4. status
リンクのコピー

ネットワークのステータス。ネットワークが 'required' と定義され、アクティブなクラスターホストから省略されている場合は non_operational になります。それ以外の場合は operational になります。

7.175.5. usages
リンクのコピー

ネットワークの使用要素のセットを定義します。

たとえば、ユーザーは、vm および display の値を使用して、ネットワークが仮想マシントラフィックに使用され、表示トラフィックにも使用されるように指定できます。

7.175.6. vdsm_name
リンクのコピー

ホストで使用されているネットワークの名前。この代替名は、ネットワーク名がホストのブリッジ名として機能するのに不適切であることが判明した場合に、VDSM によって自動的に生成されます。不適切な名前にはスペースまたは特殊文字が含まれているか、15 文字を超えており、ホスト上の UUID に置き換えられます。このパラメーターは読み取り専用です。設定しても効果はありません。

Expand

表7.232 リンクの概要
名前	型	Summary
`cluster`	クラスター	このネットワークがアタッチされているクラスターへの参照。
`data_center`	DataCenter	ネットワークがメンバーになっているデータセンターへの参照。
`external_provider`	OpenStackNetworkProvider	ネットワークが作成される OpenStack ネットワークプロバイダーへのオプションの参照。
`external_provider_physical_network`	Network	物理ネットワークアクセスに使用する必要があるネットワークへのオプションの参照。
`network_labels`	NetworkLabel[]	ネットワークに割り当てられたラベルへの参照。
`permissions`	Permission[]	ネットワークのパーミッションへの参照。
`qos`	Qos	Quality of Service への参照。
`vnic_profiles`	VnicProfile[]	ネットワークのプロファイルへの参照。

7.175.7. cluster
リンクのコピー

このネットワークがアタッチされているクラスターへの参照。クラスターレベルからネットワークにアクセスする場合にのみ入力されます。

7.175.8. external_provider
リンクのコピー

ネットワークが作成される OpenStack ネットワークプロバイダーへのオプションの参照。

ネットワークの作成時に指定すると、一致する OpenStack ネットワークも作成されます。

7.175.9. external_provider_physical_network
リンクのコピー

物理ネットワークアクセスに使用する必要があるネットワークへのオプションの参照。external_provider が指定されている場合にのみ有効です。

7.176. NetworkAttachment 構造体
リンクのコピー

ホストがネットワークに接続する方法を説明します。

ホスト上のネットワークアタッチメントの XML 表現:

<network_attachment href="/ovirt-engine/api/hosts/123/nics/456/networkattachments/789" id="789">
  <network href="/ovirt-engine/api/networks/234" id="234"/>
  <host_nic href="/ovirt-engine/api/hosts/123/nics/123" id="123"/>
  <in_sync>true</in_sync>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>192.168.122.39</address>
        <gateway>192.168.122.1</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
  <reported_configurations>
    <reported_configuration>
      <name>mtu</name>
      <expected_value>1500</expected_value>
      <actual_value>1500</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    <reported_configuration>
      <name>bridged</name>
      <expected_value>true</expected_value>
      <actual_value>true</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

<network_attachment href="/ovirt-engine/api/hosts/123/nics/456/networkattachments/789" id="789">
  <network href="/ovirt-engine/api/networks/234" id="234"/>
  <host_nic href="/ovirt-engine/api/hosts/123/nics/123" id="123"/>
  <in_sync>true</in_sync>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>192.168.122.39</address>
        <gateway>192.168.122.1</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
  <reported_configurations>
    <reported_configuration>
      <name>mtu</name>
      <expected_value>1500</expected_value>
      <actual_value>1500</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    <reported_configuration>
      <name>bridged</name>
      <expected_value>true</expected_value>
      <actual_value>true</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

Copy to Clipboard

Toggle word wrap

ネットワークをネットワークインターフェイスカード (NIC) にアタッチするには、name または id を持つネットワーク要素が必要です。

たとえば、ネットワークをホストネットワークインターフェイスカードにアタッチするには、以下のようなリクエストを送信します。

POST /ovirt-engine/api/hosts/123/nics/456/networkattachments

POST /ovirt-engine/api/hosts/123/nics/456/networkattachments

Copy to Clipboard

Toggle word wrap

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

<networkattachment>
  <network id="234"/>
</networkattachment>

<networkattachment>
  <network id="234"/>
</networkattachment>

Copy to Clipboard

Toggle word wrap

ネットワークをホストにアタッチするには、次のようなリクエストを送信します。

POST /ovirt-engine/api/hosts/123/networkattachments

POST /ovirt-engine/api/hosts/123/networkattachments

Copy to Clipboard

Toggle word wrap

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

<network_attachment>
  <network id="234"/>
  <host_nic id="456"/>
</network_attachment>

<network_attachment>
  <network id="234"/>
  <host_nic id="456"/>
</network_attachment>

Copy to Clipboard

Toggle word wrap

ip_address_assignments および properties 要素は、作成後に更新可能です。

たとえば、ネットワークアタッチメントを更新するには、以下のようなリクエストを送信します。

PUT /ovirt-engine/api/hosts/123/nics/456/networkattachments/789

PUT /ovirt-engine/api/hosts/123/nics/456/networkattachments/789

Copy to Clipboard

Toggle word wrap

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

<network_attachment>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>7.1.1.1</address>
        <gateway>7.1.1.2</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
</network_attachment>

<network_attachment>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>7.1.1.1</address>
        <gateway>7.1.1.2</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
</network_attachment>

Copy to Clipboard

Toggle word wrap

ネットワークインターフェイスカードからネットワークをデタッチするには、以下のようなリクエストを送信します。

DELETE /ovirt-engine/api/hosts/123/nics/456/networkattachments/789

DELETE /ovirt-engine/api/hosts/123/nics/456/networkattachments/789

Copy to Clipboard

Toggle word wrap

重要

ネットワークアタッチメント設定への変更は、明示的にコミットする必要があります。

ネットワークアタッチメントの properties サブコレクションの XML 表現。

<network_attachment>
  <properties>
    <property>
      <name>bridge_opts</name>
      <value>
        forward_delay=1500 group_fwd_mask=0x0 multicast_snooping=1
      </value>
    </property>
  </properties>
  ...
</network_attachment>

<network_attachment>
  <properties>
    <property>
      <name>bridge_opts</name>
      <value>
        forward_delay=1500 group_fwd_mask=0x0 multicast_snooping=1
      </value>
    </property>
  </properties>
  ...
</network_attachment>

Copy to Clipboard

Toggle word wrap

Expand

表7.233 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`dns_resolver_configuration`	DnsResolverConfiguration	GET を使用してネットワークアタッチメントを取得すると、DNS リゾルバーの設定が報告されます。
`id`	String	一意の ID
`in_sync`	ブール値
`ip_address_assignments`	IpAddressAssignment[]	ネットワークの IP 設定。
`name`	String	人間が判読できるプレーンテキストでの名前。
`properties`	Property[]	ネットワーク設定のカスタムプロパティーを定義します。
`reported_configurations`	ReportedConfiguration[]	設定プロパティーの読み取り専用リスト。

7.176.1. dns_resolver_configuration
リンクのコピー

GET を使用してネットワークアタッチメントを取得すると、DNS リゾルバーの設定が報告されます。新しいネットワークアタッチメントを作成する場合、または既存のネットワークアタッチメントを更新する場合はオプションです。

7.176.2. properties
リンクのコピー

ネットワーク設定のカスタムプロパティーを定義します。

ブリッジオプションのセット名は bridge_opts です。複数の項目を空白文字で区切ります。bridge_opts には、以下のキーが有効です。

Expand

名前	デフォルト値
`forward_delay`	`1500`
`gc_timer`	`3765`
`group_addr`	`1:80:c2:0:0:0`
`group_fwd_mask`	`0x0`
`hash_elasticity`	`4`
`hash_max`	`512`
`hello_time`	`200`
`hello_timer`	`70`
`max_age`	`2000`
`multicast_last_member_count`	`2`
`multicast_last_member_interval`	`100`
`multicast_membership_interval`	`26000`
`multicast_querier`	`0`
`multicast_querier_interval`	`25500`
`multicast_query_interval`	`13000`
`multicast_query_response_interval`	`1000`
`multicast_query_use_ifaddr`	`0`
`multicast_router`	`1`
`multicast_snooping`	`1`
`multicast_startup_query_count`	`2`
`multicast_startup_query_interval`	`3125`

Expand

表7.234 リンクの概要
名前	型	Summary
`host`	ホスト
`host_nic`	HostNic	ホストネットワークインターフェイスへの参照。
`network`	Network	インターフェイスがアタッチされているネットワークへの参照。
`qos`	Qos

7.177. NetworkConfiguration 構造体
リンクのコピー

Expand

表7.235 属性の概要
名前	型	Summary
`dns`	Dns
`nics`	Nic[]

7.178. NetworkFilter 構造体
リンクのコピー

ネットワークフィルターは、定義されたルールに従って、仮想マシンの NIC との間で送受信されるパケットをフィルタリングします。

libvirt に基づいてサポートされるネットワークフィルターには、いくつかのタイプがあります。さまざまなネットワークフィルターの詳細は、こちらを参照してください。

デフォルトのネットワークフィルターは、ネットワークの種類と設定に基づいています。EnableMACAntiSpoofingFilterRules が True の場合、仮想マシンネットワークのデフォルトフィルターは vdsm-no-mac-spoof です。それ以外の場合、フィルターは設定されません。OVN ネットワークの場合、フィルターは設定されません。

libvirt のネットワークフィルターに加えて、2 つの追加のネットワークフィルターがあります。1 つは vdsm-no-mac-spoofing と呼ばれ、no-mac-spoofing および no-arp-mac-spoofing で構成されています。もう 1 つは ovirt-no-filter と呼ばれ、仮想マシンの NIC にネットワークフィルターを定義しない場合に使用されます。ovirt-no-filter ネットワークフィルターは内部実装にのみ使用され、NIC には存在しません。

これは XML 表現の例です。

<network_filter id="00000019-0019-0019-0019-00000000026c">
  <name>example-filter</name>
  <version>
    <major>4</major>
    <minor>0</minor>
    <build>-1</build>
    <revision>-1</revision>
  </version>
</network_filter>

<network_filter id="00000019-0019-0019-0019-00000000026c">
  <name>example-filter</name>
  <version>
    <major>4</major>
    <minor>0</minor>
    <build>-1</build>
    <revision>-1</revision>
  </version>
</network_filter>

Copy to Clipboard

Toggle word wrap

バージョンの一部が存在しない場合は、-1 で表されます。

Expand

表7.236 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`version`	バージョン	特定の NetworkFilter の最小サポート対象バージョン。

7.178.1. version
リンクのコピー

特定の NetworkFilter の最小サポート対象バージョン。これは、NetworkFilter が最初に導入されたバージョンです。

7.179. NetworkFilterParameter 構造体
リンクのコピー

ネットワークフィルターのパラメーター。

詳細は、Libvirt-Filters を参照してください。これは XML 表現の例です。

<network_filter_parameter id="123">
  <name>IP</name>
  <value>10.0.1.2</value>
</network_filter_parameter>

<network_filter_parameter id="123">
  <name>IP</name>
  <value>10.0.1.2</value>
</network_filter_parameter>

Copy to Clipboard

Toggle word wrap

Expand

表7.237 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`value`	String	パラメーターの値を表します。

Expand

表7.238 リンクの概要
名前	型	Summary
`nic`	Nic	パラメーターが関連付けられている仮想マシンの NIC。

7.180. NetworkLabel 構造体
リンクのコピー

ホストネットワークインターフェイスとネットワークに追加できるラベルを表します。ラベルは、ラベル id によってネットワークとホストネットワークインターフェイスをバインドします。

Expand

表7.239 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.240 リンクの概要
名前	型	Summary
`host_nic`	HostNic	このラベルを含むホストネットワークインターフェイスへの参照。
`network`	Network	このラベルを含むネットワークへの参照。

7.181. NetworkPluginType enum
リンクのコピー

ネットワークプラグインタイプ。

ホスト上のプロバイダードライバーの実装を指定します。

Red Hat Virtualization Manager のバージョン 4.2 以降、このタイプは非推奨となり、OpenStackNetworkProvider タイプの external_plugin_type 属性が使用されるようになりました。

Expand

表7.241 値の概要
名前	Summary
`open_vswitch`	Open vSwitch

7.181.1. open_vswitch
リンクのコピー

Open vSwitch

このプロバイダーに Open vSwitch ベースのドライバー実装を使用する必要があることを指定します。

Red Hat Virtualization Manager のバージョン 4.2 以降、この値は非推奨になりました。代わりに、OpenStackNetworkProvider.external_plugin_type 属性で文字列 open_vswitch を使用してください。

7.182. NetworkStatus enum
リンクのコピー

Expand

表7.242 値の概要
名前	Summary
`non_operational`
`operational`

7.183. NetworkUsage enum
リンクのコピー

このタイプは、クラスター内でネットワークが使用される目的を示します。

Expand

表7.243 値の概要
名前	Summary
`default_route`	ホストのデフォルトゲートウェイと DNS リゾルバー設定は、このネットワークから取得されます。
`display`	ネットワークは、SPICE および VNC トラフィックに使用されます。
`gluster`	ネットワークは、Gluster (ブリック) データトラフィックに使用されます。
`management`	ネットワークは、Red Hat Virtualization Manager とノード間の通信に使用されます。
`migration`	このネットワークは、仮想マシンの移行に使用されます。
`vm`

7.183.1. default_route
リンクのコピー

ホストのデフォルトゲートウェイと DNS リゾルバー設定は、このネットワークから取得されます。

このネットワークがホストにアタッチされている場合、DNS リゾルバー設定は、ネットワークアタッチメントの dns_resolver_configuration 属性から取得されます。このネットワークアタッチメントに dns_resolver_configuration 属性がない場合は、ネットワーク自体の dns_resolver_configuration から取得されます。そこにも dns_resolver_configuration 属性が存在しない場合、DNS リゾルバーは設定されません。

このフラグをネットワークに設定すると、ホストのデフォルトゲートウェイは、ネットワークアタッチメントの ip_address_assignment の gateway 属性から取得されます。

7.183.2. management
リンクのコピー

ネットワークは、Red Hat Virtualization Manager とノード間の通信に使用されます。これは、ovirtmgmt ブリッジが作成されるネットワークです。

7.184. NfsProfileDetail struct
リンクのコピー

Expand

表7.244 属性の概要
名前	型	Summary
`nfs_server_ip`	String
`profile_details`	ProfileDetail[]

7.185. NfsVersion enum
リンクのコピー

Expand

表7.245 値の概要
名前	Summary
`auto`
`v3`
`v4`
`v4_0`	NFS 4.
`v4_1`
`v4_2`	NFS 4.

7.185.1. v4_0
リンクのコピー

NFS 4.0.

7.185.2. v4_2
リンクのコピー

NFS 4.2.

7.186. Nic 構造体
リンクのコピー

仮想マシン NIC を表します。

たとえば、NIC の XML 表現は以下のようになります。

<nic href="/ovirt-engine/api/vms/123/nics/456" id="456">
  <name>nic1</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <interface>virtio</interface>
  <linked>true</linked>
  <mac>
    <address>02:00:00:00:00:00</address>
  </mac>
  <plugged>true</plugged>
  <vnic_profile href="/ovirt-engine/api/vnicprofiles/789" id="789"/>
</nic>

<nic href="/ovirt-engine/api/vms/123/nics/456" id="456">
  <name>nic1</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <interface>virtio</interface>
  <linked>true</linked>
  <mac>
    <address>02:00:00:00:00:00</address>
  </mac>
  <plugged>true</plugged>
  <vnic_profile href="/ovirt-engine/api/vnicprofiles/789" id="789"/>
</nic>

Copy to Clipboard

Toggle word wrap

Expand

表7.246 属性の概要
名前	型	Summary
`boot_protocol`	BootProtocol	NIC に IP アドレスを割り当てる方法を定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`interface`	NicInterface	NIC に使用されるドライバーのタイプ。
`linked`	ブール値	NIC が仮想マシンにリンクされているかどうかを定義します。
`mac`	Mac	インターフェイスの MAC アドレス。
`name`	String	人間が判読できるプレーンテキストでの名前。
`on_boot`	ブール値	オペレーティングシステムの起動時にネットワークインターフェイスをアクティブにするかどうかを定義します。
`plugged`	ブール値	NIC が仮想マシンに接続されているかどうかを定義します。
`synced`	ブール値	仮想マシンの NIC 設定がエンジンによって表される設定と同期されるかどうかを定義します。

Expand

表7.247 リンクの概要
名前	型	Summary
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`network`	Network	インターフェイスが接続されるべきネットワークへの参照。
`network_attachments`	NetworkAttachment[]	ホスト NIC に関連付けられているネットワークアタッチメントのコレクションへのリンク。
`network_filter_parameters`	NetworkFilterParameter[]	ネットワークフィルターパラメーターへのリンク。
`network_labels`	NetworkLabel[]	ホスト NIC に関連付けられているネットワークラベルのコレクションへのリンク。
`reported_devices`	ReportedDevice[]	仮想ネットワークインターフェイスに関連付けられている報告されたデバイスのコレクションへのリンク。
`statistics`	Statistic[]	NIC の統計へのリンク。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`virtual_function_allowed_labels`	NetworkLabel[]	SR-IOV NIC の仮想機能にアタッチできるネットワークラベルのコレクションへのリンク。
`virtual_function_allowed_networks`	Network[]	SR-IOV NIC の仮想機能にアタッチできるネットワークのコレクションへのリンク。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。
`vnic_profile`	VnicProfile	関連する仮想ネットワークインターフェイスプロファイルへのリンク。

7.186.1. network
リンクのコピー

インターフェイスが接続されるべきネットワークへの参照。空白のネットワーク ID を使用できます。

NIC の作成または更新におけるこの要素の使用は非推奨になりました。代わりに vnic_profile を使用してください。これは、IP アドレスやその他のネットワーク詳細のホルダーとして、initialization 要素によってまだ使用されているため保存されます。

7.186.2. vms
リンクのコピー

7.187. NicConfiguration 構造体
リンクのコピー

タイプは、仮想ネットワークインターフェイスの設定を表します。

Expand

表7.248 属性の概要
名前	型	Summary
`boot_protocol`	BootProtocol	IPv4 ブートプロトコル。
`ip`	Ip	IPv4 アドレスの詳細。
`ipv6`	Ip	IPv6 アドレスの詳細。
`ipv6_boot_protocol`	BootProtocol	IPv6 ブートプロトコル。
`name`	String	ネットワークインターフェイス名。
`on_boot`	ブール値	仮想マシンのゲストオペレーティングシステムの起動時にネットワークインターフェイスをアクティブにするかどうかを指定します。

7.188. NicInterface enum
リンクのコピー

エミュレートされた仮想ネットワークインターフェイスデバイスモデルのオプションを定義します。

Expand

表7.249 値の概要
名前	Summary
`e1000`	e1000。
`e1000e`	e1000e。
`pci_passthrough`	PCI パススルー。
`rtl8139`	rtl8139.
`rtl8139_virtio`	デュアルモード rtl8139、VirtIO。
`spapr_vlan`	sPAPR VLAN。
`virtio`	VirtIO。

7.189. NicStatus enum
リンクのコピー

ネットワークインターフェイスカードのステータス。

Expand

表7.250 値の概要
名前	Summary
`down`	NIC がダウンしており、アクセスできません。
`up`	NIC が起動しており、アクセスできます。

7.190. NotifiableEvent enum
リンクのコピー

Red Hat Virtualization サーバーのイベントのサブセットを表すタイプ。ユーザーは、これをサブスクライブして通知を受け取ることができます。

Expand

表7.251 値の概要
名前	Summary
`cluster_alert_ha_reservation`	HA 予約チェックに失敗しました
`cluster_alert_ha_reservation_down`	HA 予約チェックに合格しました
`dwh_error`	ETL サービスエラー
`dwh_stopped`	ETL サービスが停止しました
`engine_backup_completed`	エンジンのバックアップが正常に完了しました
`engine_backup_failed`	エンジンのバックアップに失敗しました
`engine_backup_started`	エンジンのバックアップが開始しました
`engine_ca_certification_has_expired`	エンジン CA の認証の有効期限が切れています
`engine_ca_certification_is_about_to_expire`	エンジンの CA 証明書の有効期限がまもなく切れます
`engine_certification_has_expired`	エンジンの認証の有効期限が切れています
`engine_certification_is_about_to_expire`	エンジンの証明書の有効期限がまもなく切れます
`engine_stop`	エンジンが停止しました
`faulty_multipaths_on_host`	ホスト上にある、障害のあるマルチパスのパス
`gluster_brick_status_changed`	ブリックの状態変化を検出しました
`gluster_hook_add_failed`	競合するサーバーに Gluster Hook を追加できませんでした
`gluster_hook_added`	Gluster Hook を追加しました
`gluster_hook_conflict_detected`	Gluster Hook で競合が検出されました
`gluster_hook_detected_delete`	Gluster Hook の削除が検出されました
`gluster_hook_detected_new`	新しい Gluster Hook を検出しました
`gluster_hook_disable`	Gluster フックが無効化されました
`gluster_hook_disable_failed`	Gluster Hook を無効化できませんでした
`gluster_hook_enable`	Gluster Hook が有効化されました
`gluster_hook_enable_failed`	Gluster フックを有効化できませんでした
`gluster_hook_remove_failed`	クラスターから Gluster Hook を削除できませんでした
`gluster_hook_removed`	Gluster Hook を削除しました
`gluster_server_add_failed`	Gluster サーバーを追加できませんでした
`gluster_server_remove`	Gluster サーバーが削除されました
`gluster_server_remove_failed`	Gluster サーバーの削除に失敗しました
`gluster_service_restart_failed`	Gluster サービスの再起動に失敗しました
`gluster_service_restarted`	Gluster サービスが再起動されました
`gluster_service_start_failed`	Gluster サービスの開始に失敗しました
`gluster_service_started`	Gluster サービスが開始されました
`gluster_service_stop_failed`	Gluster サービスを停止できませんでした
`gluster_service_stopped`	Gluster サービスが停止しました
`gluster_volume_add_brick`	Gluster ボリュームブリックが追加されました
`gluster_volume_add_brick_failed`	Gluster ボリュームにブリックを追加できませんでした
`gluster_volume_all_snapshots_delete_failed`	ボリュームのスナップショットを削除できませんでした
`gluster_volume_all_snapshots_deleted`	ボリュームですべてのスナップショットが削除されました
`gluster_volume_brick_replaced`	グラスターボリュームブリックが置き換えられました
`gluster_volume_confirmed_space_low`	ボリュームの空き容量が少ないことが確認されました
`gluster_volume_create`	Gluster ボリュームが作成されました
`gluster_volume_create_failed`	Gluster ボリュームを作成できませんでした
`gluster_volume_delete`	Gluster ボリュームが削除されました
`gluster_volume_delete_failed`	Gluster ボリュームを削除できませんでした
`gluster_volume_migrate_brick_data_finished`	ブリックを削除するための Gluster ボリュームのデータ移行が完了しました
`gluster_volume_option_added`	Gluster ボリュームオプションが追加されました
`gluster_volume_option_modified`	Gluster ボリュームオプションが変更されました
`gluster_volume_option_set_failed`	Gluster ボリュームオプションを設定できませんでした
`gluster_volume_options_reset`	Gluster ボリュームオプションがリセットされました
`gluster_volume_options_reset_all`	すべての Gluster ボリュームオプションがリセットされました
`gluster_volume_options_reset_failed`	Gluster ボリュームオプションをリセットできませんでした
`gluster_volume_profile_start`	Gluster ボリュームプロファイルを開始しました
`gluster_volume_profile_start_failed`	Gluster ボリュームプロファイルの開始に失敗しました
`gluster_volume_profile_stop`	Gluster ボリュームプロファイルが停止しました
`gluster_volume_profile_stop_failed`	Gluster ボリュームプロファイルの停止に失敗しました
`gluster_volume_rebalance_finished`	Gluster ボリュームのリバランスが終了しました
`gluster_volume_rebalance_not_found_from_cli`	CLI からボリューム上のリバランスの情報が見つかりませんでした。
`gluster_volume_rebalance_start`	Gluster ボリュームリバランスが開始されました
`gluster_volume_rebalance_start_detected_from_cli`	CLI から gluster ボリュームのリバランスの開始が検出されました
`gluster_volume_rebalance_start_failed`	Gluster ボリュームリバランスを開始できませんでした
`gluster_volume_rebalance_stop`	Gluster ボリュームのリバランスが停止しました
`gluster_volume_rebalance_stop_failed`	Gluster ボリュームのリバランスを停止できませんでした
`gluster_volume_remove_bricks`	Gluster ボリュームブリックが削除されました
`gluster_volume_remove_bricks_failed`	Gluster ボリュームブリックを削除できませんでした
`gluster_volume_remove_bricks_stop`	Gluste ボリュームからのブリックの削除を停止しました
`gluster_volume_remove_bricks_stop_failed`	Gluster ボリュームからのブリックの削除を停止できませんでした
`gluster_volume_replace_brick_failed`	Gluster ボリュームのブリック置き換えに失敗しました
`gluster_volume_replace_brick_start`	Gluster ボリュームのブリック置き換えが開始されました
`gluster_volume_replace_brick_start_failed`	Gluster ボリュームのブリック置き換えを開始できませんでした
`gluster_volume_snapshot_activate_failed`	ボリュームでスナップショットをアクティブ化できませんでした
`gluster_volume_snapshot_activated`	ボリュームでスナップショットがアクティブ化されました
`gluster_volume_snapshot_create_failed`	${clusterName} クラスターで ${glusterVolumeName} のボリュームのスナップショットが作成できませんでした。
`gluster_volume_snapshot_created`	${clusterName} クラスターで ${glusterVolumeName} ボリュームの ${snapname} スナップショットが作成されました。
`gluster_volume_snapshot_deactivate_failed`	ボリュームのスナップショットを非アクティブ化できませんでした
`gluster_volume_snapshot_deactivated`	ボリュームのスナップショットが非アクティブ化されました
`gluster_volume_snapshot_delete_failed`	ボリュームのスナップショットを削除できませんでした
`gluster_volume_snapshot_deleted`	ボリュームのスナップショットが削除されました
`gluster_volume_snapshot_restore_failed`	ボリュームのスナップショットを復元できませんでした
`gluster_volume_snapshot_restored`	ボリュームのスナップが復元されました
`gluster_volume_start`	Gluster ボリュームが開始されました
`gluster_volume_start_failed`	Gluster ボリュームを開始できませんでした
`gluster_volume_stop`	Gluster ボリュームが停止しました
`gluster_volume_stop_failed`	Gluster ボリュームを停止できませんでした
`ha_vm_failed`	高可用性仮想マシンが失敗しました
`ha_vm_restart_failed`	高可用性 VM の再起動に失敗しました
`host_activate_failed`	ホストのアクティブ化に失敗しました
`host_activate_manual_ha`	ホストはアクティブ化されましたが、ホスト型エンジン HA サービスは引き続きメンテナンスモードである可能性があります
`host_approve_failed`	ホストの承認に失敗しました
`host_bond_slave_state_down`	ホストのボンディングのスレーブが状態をダウンに変更しました
`host_certificate_has_invalid_san`	ホストの証明書に無効なサブジェクト代替名 (SAN) が含まれています
`host_certification_has_expired`	ホストの認定の有効期限が切れています
`host_certification_is_about_to_expire`	ホストの証明書の有効期限がまもなく切れます
`host_failure`	ホストが応答しません
`host_high_cpu_use`	ホストの CPU 使用量が定義されたしきい値を超えました
`host_high_mem_use`	ホストのメモリー使用量が定義されたしきい値を超えました
`host_high_swap_use`	ホストスワップのメモリー使用量が定義されたしきい値を超えました
`host_initiated_run_vm_failed`	別のホストで VM を再起動できませんでした
`host_install_failed`	ホストのインストールに失敗しました
`host_interface_high_network_use`	ホストネットワークインターフェイスの使用量が定義されたしきい値を超えました
`host_interface_state_down`	ホストのインターフェイスの状態がダウンに変更されました
`host_low_mem`	ホストの空きメモリーが定義されたしきい値を下回っています
`host_low_swap`	ホストの空きスワップメモリーが定義されたしきい値を下回っています
`host_recover_failed`	ホストの復旧に失敗しました
`host_set_nonoperational`	ホストの状態が non-operational に設定されました
`host_set_nonoperational_domain`	ストレージドメインにアクセスできないため、ホストの状態が操作不能に設定されました
`host_set_nonoperational_iface_down`	インターフェイスがないため、ホストの状態が non-operational に設定されました
`host_slow_storage_response_time`	ストレージの応答時間が遅いです
`host_time_drift_alert`	ホストには時間のずれがあります
`host_untrusted`	ホストの状態が non-operational に設定されました。
`host_updates_are_available`	ホストには利用可能な更新があります
`host_updates_are_available_with_packages`	ホストには更新可能なパッケージがあります
`importexport_import_template_from_trusted_to_untrusted`	テンプレートが信頼できるクラスターから信頼できないクラスターにインポートされました
`importexport_import_template_from_untrusted_to_trusted`	テンプレートが信頼できないクラスターから信頼できるクラスターにインポートされました
`importexport_import_vm_from_trusted_to_untrusted`	仮想マシンを信頼できるクラスターから信頼できないクラスターにインポートします
`importexport_import_vm_from_untrusted_to_trusted`	仮想マシンを信頼できないクラスターから信頼できるクラスターにインポートします
`irs_confirmed_disk_space_low`	ディスク容量が少ないことが確認されました
`irs_disk_space_low`	ディスク領域不足
`irs_disk_space_low_error`	ディスク容量が極端に少ない
`irs_failure`	ストレージへのアクセスに失敗しました
`mac_address_is_external`	外部 MAC アドレスを持つ VM
`multipath_devices_without_valid_paths_on_host`	ホストに有効なパスがないマルチパスデバイス
`network_update_display_for_cluster_with_active_vm`	アクティブな VM を持つクラスターでディスプレイネットワークが更新されました
`network_update_display_for_host_with_active_vm`	アクティブな VM を持つホストでディスプレイネットワークが更新されました
`no_faulty_multipaths_on_host`	ホスト上に障害のあるマルチパスのパスはありません
`number_of_lvs_on_storage_domain_exceeded_threshold`	ストレージドメインの LV の数がしきい値を超えました
`remove_gluster_volume_bricks_not_found_from_cli`	CLI からボリューム上のブリックを削除するための情報が見つかりませんでした。
`start_removing_gluster_volume_bricks`	ボリュームからブリックを削除し始めました
`start_removing_gluster_volume_bricks_detected_from_cli`	CLI からのボリューム上のブリックのブリック除去の開始が検出されました
`start_removing_gluster_volume_bricks_failed`	ボリュームブリックを削除できませんでした
`system_change_storage_pool_status_no_host_for_spm`	データセンターの SPM の選択に失敗しました
`system_deactivated_storage_domain`	ストレージドメインの状態が非アクティブに設定されました
`user_add_vm_from_trusted_to_untrusted`	信頼できない VM が信頼できるテンプレートから作成されました
`user_add_vm_from_untrusted_to_trusted`	信頼できる VM は、信頼できないテンプレートから作成されました
`user_add_vm_template_from_trusted_to_untrusted`	信頼できないテンプレートが信頼できる VM から作成されました
`user_add_vm_template_from_untrusted_to_trusted`	信頼できるテンプレートが信頼できない VM から作成されました
`user_host_maintenance`	ホストが Maintenance Mode に切り替えられました
`user_host_maintenance_manual_ha`	ホストは、メンテナンスモードに切り替わりましたが、ホストエンジンの HA メンテナンスモードを有効化できませんでした
`user_host_maintenance_migration_failed`	ホストを Maintenance Mode に切り替えることができませんでした
`user_update_vm_from_trusted_to_untrusted`	VM が信頼できるクラスターから信頼できないクラスターに移動しました
`user_update_vm_from_untrusted_to_trusted`	VM が信頼できないクラスターから信頼できるクラスターに移動しました
`user_update_vm_template_from_trusted_to_untrusted`	テンプレートが信頼できるクラスターから信頼できないクラスターに移動しました
`user_update_vm_template_from_untrusted_to_trusted`	テンプレートが信頼できないクラスターから信頼できるクラスターに移動しました
`vm_console_connected`	接続された VM コンソール
`vm_console_disconnected`	VM コンソールが切断されました
`vm_down_error`	VM がエラーを表示してダウンしています
`vm_failure`	ホストで VM が見つかりません
`vm_migration_failed`	移行に失敗しました
`vm_migration_start`	VM の移行を開始します
`vm_migration_to_server_failed`	移行先ホストへの VM の移行に失敗しました
`vm_not_responding`	VM が応答していません
`vm_paused`	VM が一時停止されました
`vm_paused_eio`	ストレージ I/O エラーのために VM が一時停止されました
`vm_paused_enospc`	ストレージスペースが不足しているため、VM が一時停止されました
`vm_paused_eperm`	ストレージの読み取り/書き込み権限の問題により、VM が一時停止されました
`vm_paused_error`	仮想マシンは不明なストレージエラーが原因で一時停止されました
`vm_recovered_from_pause_error`	仮想マシンが一時停止から稼働中に復元されました
`vm_set_ticket`	VM コンソールセッションが開始されました
`vm_status_restored`	VM ステータスが復元されました

7.190.1. gluster_volume_rebalance_not_found_from_cli
リンクのコピー

CLI からボリューム上のリバランスの情報が見つかりませんでした。不明とマークします。

7.190.2. host_untrusted
リンクのコピー

ホストの状態が non-operational に設定されました。ホストは認証サービスによって信頼されていません

7.190.3. remove_gluster_volume_bricks_not_found_from_cli
リンクのコピー

CLI からボリューム上のブリックを削除するための情報が見つかりませんでした。不明とマークします。

7.191. NotificationMethod enum
リンクのコピー

イベントサブスクリプションの通知方法を表すタイプ。現在 API でサポートされているのは SMTP のみです。将来的には、SNMP 通知のサポートが追加される可能性があります。

Expand

表7.252 値の概要
名前	Summary
`smtp`	電子メールによる通知。
`snmp`	SNMP による通知。

7.191.1. smtp
リンクのコピー

電子メールによる通知。

SMTP 通知メソッドを使用するイベントサブスクリプションには、アドレスフィールドに電子メールアドレスが含まれます。

7.191.2. snmp
リンクのコピー

SNMP による通知。

SNMP 通知メソッドを使用するイベントサブスクリプションには、アドレスフィールドに SNMP アドレスが含まれます。

7.192. NumaNode struct
リンクのコピー

物理 NUMA ノードを表します。

XML 表現の例:

<host_numa_node href="/ovirt-engine/api/hosts/0923f1ea/numanodes/007cf1ab" id="007cf1ab">
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>65536</memory>
  <node_distance>40 20 40 10</node_distance>
  <host href="/ovirt-engine/api/hosts/0923f1ea" id="0923f1ea"/>
</host_numa_node>

<host_numa_node href="/ovirt-engine/api/hosts/0923f1ea/numanodes/007cf1ab" id="007cf1ab">
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>65536</memory>
  <node_distance>40 20 40 10</node_distance>
  <host href="/ovirt-engine/api/hosts/0923f1ea" id="0923f1ea"/>
</host_numa_node>

Copy to Clipboard

Toggle word wrap

Expand

表7.253 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`cpu`	Cpu
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`index`	Integer
`memory`	Integer	NUMA ノードのメモリー (MB)。
`name`	String	人間が判読できるプレーンテキストでの名前。
`node_distance`	String

Expand

表7.254 リンクの概要
名前	型	Summary
`host`	ホスト
`statistics`	Statistic[]	各ホスト NUMA ノードリソースは、ホスト NUMA ノード固有の統計の統計サブコレクションを公開します。

7.192.1. statistics
リンクのコピー

各ホスト NUMA ノードリソースは、ホスト NUMA ノード固有の統計の統計サブコレクションを公開します。

XML 表現の例:

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" />
  </statistic>
    ...
</statistics>

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" />
  </statistic>
    ...
</statistics>

Copy to Clipboard

Toggle word wrap

注記

この統計サブコレクションは読み取り専用です。

次のリストは、ホスト NUMA ノードの統計タイプを示しています。

Expand

名前	説明
`memory.total`	NUMA ノードの合計メモリー (バイト単位)。
`memory.used`	NUMA ノードで使用されるメモリー (バイト単位)。
`memory.free`	NUMA ノードの空きメモリー (バイト単位)。
`cpu.current.user`	ユーザースライスの CPU 使用率。
`cpu.current.system`	システムの CPU 使用率。
`cpu.current.idle`	アイドル状態の CPU 使用率。

7.193. NumaNodePin struct
リンクのコピー

仮想 NUMA ノードの物理 NUMA ノードへのピニングを表します。

Expand

表7.255 属性の概要
名前	型	Summary
`host_numa_node`	NumaNode	非推奨。
`index`	Integer	仮想 NUMA ノードがピニングされている物理 NUMA ノードのインデックス。
`pinned`	ブール値	非推奨。

7.193.1. host_numa_node
リンクのコピー

非推奨。機能はありません。

7.193.2. pinned
リンクのコピー

非推奨。常に true である必要があります。

7.194. NumaTuneMode enum
リンクのコピー

Expand

表7.256 値の概要
名前	Summary
`interleave`
`preferred`
`strict`

7.195. OpenStackImage 構造体
リンクのコピー

Expand

表7.257 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.258 リンクの概要
名前	型	Summary
`openstack_image_provider`	OpenStackImageProvider

7.196. OpenStackImageProvider struct
リンクのコピー

Expand

表7.259 属性の概要
名前	型	Summary
`authentication_url`	String	外部プロバイダー認証 URL アドレスを定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`password`	String	認証プロセス中にユーザーのパスワードを定義します。
`properties`	Property[]	プロバイダー名/値のプロパティーの配列。
`requires_authentication`	ブール値	プロバイダー認証が必要かどうかを定義します。
`tenant-name`	String	OpenStack Identity API v2 のテナント名を定義します。
`url`	String	外部プロバイダーの URL アドレスを定義します。
`username`	String	認証プロセス中に使用されるユーザー名を定義します。

7.196.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

7.196.2. tenant-name
リンクのコピー

OpenStack Identity API v2.0 のテナント名を定義します。

Expand

表7.260 リンクの概要
名前	型	Summary
`certificates`	Certificate[]
`images`	OpenStackImage[]

7.197. OpenStackNetwork 構造体
リンクのコピー

Expand

表7.261 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.262 リンクの概要
名前	型	Summary
`openstack_network_provider`	OpenStackNetworkProvider

7.198. OpenStackNetworkProvider 構造体
リンクのコピー

Expand

表7.263 属性の概要
名前	型	Summary
`agent_configuration`	AgentConfiguration	非推奨エージェントの設定オプション。
`authentication_url`	String	外部プロバイダー認証 URL アドレスを定義します。
`auto_sync`	ブール値	このプロバイダーのネットワークが自動的に同期されるかどうかを示します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`external_plugin_type`	String	ネットワークプラグインタイプ。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`password`	String	認証プロセス中にユーザーのパスワードを定義します。
`plugin_type`	NetworkPluginType	ネットワークプラグインタイプ。
`project_domain_name`	String	OpenStack Identity API v3 のプロジェクトのドメイン名を定義します。
`project_name`	String	OpenStack Identity API v3 のプロジェクト名を定義します。
`properties`	Property[]	プロバイダー名/値のプロパティーの配列。
`read_only`	ブール値	プロバイダーが読み取り専用かどうかを示します。
`requires_authentication`	ブール値	プロバイダー認証が必要かどうかを定義します。
`tenant-name`	String	OpenStack Identity API v2 のテナント名を定義します。
`type`	OpenStackNetworkProviderType	プロバイダーのタイプ。
`unmanaged`	ブール値	プロバイダーが Red Hat Virtualization によって管理されていないかどうかを示します。
`url`	String	外部プロバイダーの URL アドレスを定義します。
`user_domain_name`	String	OpenStack Identity API v3 の ExternalProvider で `username` のドメイン名を定義します。
`username`	String	認証プロセス中に使用されるユーザー名を定義します。

7.198.1. agent_configuration
リンクのコピー

非推奨エージェントの設定オプション。

Red Hat Virtualization 4.4.0 以降、OpenStack Neutron エージェントのデプロイメントが削除されたため、無視されます。

7.198.2. auto_sync
リンクのコピー

このプロバイダーのネットワークが自動的に同期されるかどうかを示します。

true の場合、このプロバイダーのネットワークはバックグラウンドで Red Hat Virtualization に自動的かつ周期的に同期されます。これは、このプロバイダーのすべての新しいネットワークがインポートされ、すべての破棄されたネットワークが、この外部プロバイダーをデフォルトプロバイダーとして持つすべてのクラスターから削除されることを意味します。プロバイダーでネットワークの名前が変更された場合、その変更は Red Hat Virtualization のネットワークエンティティーに同期されます。さらに、プロバイダーをデフォルトのプロバイダーとして持つ新しいクラスターが追加された場合、すでにインポートされたネットワークは、同期中にこの新しいクラスターにアタッチされます。

自動的に開始されたインポートにより、以下のステップがトリガーされます。

外部プロバイダーのネットワークは、その外部プロバイダーをデフォルトプロバイダーとして持つクラスターのデータセンター内のすべてのデータセンターにインポートされます。
関連するデータセンターとネットワークごとに vNIC プロファイルが作成されます。
ネットワークは、デフォルトプロバイダーとしてその外部プロバイダーを持つ各クラスターに割り当てられます。

すべてのユーザーは、新しい vNIC プロファイルを使用できます。

後方互換性向けのデフォルトは false です。

7.198.3. external_plugin_type
リンクのコピー

ネットワークプラグインタイプ。

この属性を使用すると、外部 NIC が追加または変更されたときに、ホストで正しいプロバイダードライバーを選択できます。ドライバーの自動インストールがサポートされている場合 (ovirt-provider-ovn などの一部の定義済み実装でのみ使用可能)、この属性により、新しく追加されたホストにインストールするドライバー実装をシステムが決定できるようになります。

7.198.4. plugin_type
リンクのコピー

ネットワークプラグインタイプ。

Red Hat Virtualization Manager のバージョン 4.2 以降、この属性は非推奨になり、external_plugin_type が使用されるようになりました。この属性はタイプが open_vswitch のプロバイダーに対してのみ有効であり、external_plugin_type 属性の値が open_vswitch と等しい場合にのみ返されます。

更新中に plugin_type と external_plugin_type の両方が指定された場合、plugin_type の値は無視されます。

外部プロバイダーの場合、この値は表示されず、更新リクエスト中に無視されます。

7.198.5. read_only
リンクのコピー

プロバイダーが読み取り専用かどうかを示します。

読み取り専用プロバイダーでは、ネットワークまたはサブネットの追加、変更、削除は許可されません。ポート関連の操作は、仮想 NIC のプロビジョニングに必要なため、許可されます。

7.198.6. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

7.198.7. tenant-name
リンクのコピー

OpenStack Identity API v2.0 のテナント名を定義します。

7.198.8. unmanaged
リンクのコピー

プロバイダーが Red Hat Virtualization によって管理されていないかどうかを示します。

true の場合、認証とサブネット制御は完全に外部プロバイダーに委ねられ、Red Hat Virtualization によって管理されません。

後方互換性向けのデフォルトは false です。

Expand

表7.264 リンクの概要
名前	型	Summary
`certificates`	Certificate[]	証明書リストへの参照。
`networks`	OpenStackNetwork[]	OpenStack ネットワークリストへの参照。
`subnets`	OpenStackSubnet[]	OpenStack ネットワークのサブネットリストへの参照。

7.199. OpenStackNetworkProviderType enum
リンクのコピー

OpenStack ネットワークプロバイダーは、OpenStack Neutron によって実装できます。この場合、Neutron エージェントはホストに自動的にインストールされます。または、OpenStack API を実装する外部プロバイダーにすることもできます。この場合、仮想インターフェイスドライバーはカスタムソリューションであり、手動でインストールされます。

Expand

表7.265 値の概要
名前	Summary
`external`	プロバイダーが OpenStack Neutron API を実装する外部プロバイダーであることを示します。
`neutron`	プロバイダーが OpenStack Neutron であることを示します。

7.199.1. external
リンクのコピー

プロバイダーが OpenStack Neutron API を実装する外部プロバイダーであることを示します。この場合の仮想インターフェイスドライバーは、外部プロバイダーによって実装されます。

7.199.2. neutron
リンクのコピー

プロバイダーが OpenStack Neutron であることを示します。標準の OpenStack Neutron エージェントは、仮想インターフェイスドライバーとして使用されます。

7.200. OpenStackProvider 構造体
リンクのコピー

Expand

表7.266 属性の概要
名前	型	Summary
`authentication_url`	String	外部プロバイダー認証 URL アドレスを定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`password`	String	認証プロセス中にユーザーのパスワードを定義します。
`properties`	Property[]	プロバイダー名/値のプロパティーの配列。
`requires_authentication`	ブール値	プロバイダー認証が必要かどうかを定義します。
`tenant-name`	String	OpenStack Identity API v2 のテナント名を定義します。
`url`	String	外部プロバイダーの URL アドレスを定義します。
`username`	String	認証プロセス中に使用されるユーザー名を定義します。

7.200.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

7.200.2. tenant-name
リンクのコピー

OpenStack Identity API v2.0 のテナント名を定義します。

7.201. OpenStackSubnet 構造体
リンクのコピー

Expand

表7.267 属性の概要
名前	型	Summary
`cidr`	String	ネットワーク CIDR を定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`dns_servers`	String[]	DNS サーバーのリストを定義します。
`gateway`	String	IP ゲートウェイを定義します。
`id`	String	一意の ID
`ip_version`	String	IP バージョンを定義します。
`name`	String	人間が判読できるプレーンテキストでの名前。

7.201.1. ip_version
リンクのコピー

IP バージョンを定義します。

IPv6 では、値は v4' for IPv4 or `v6 になります。

Expand

表7.268 リンクの概要
名前	型	Summary
`openstack_network`	OpenStackNetwork	OpenStack ネットワークを管理するサービスへの参照。

7.202. OpenStackVolumeProvider 構造体
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表7.269 属性の概要
名前	型	Summary
`authentication_url`	String	外部プロバイダー認証 URL アドレスを定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`password`	String	認証プロセス中にユーザーのパスワードを定義します。
`properties`	Property[]	プロバイダー名/値のプロパティーの配列。
`requires_authentication`	ブール値	プロバイダー認証が必要かどうかを定義します。
`tenant-name`	String	OpenStack Identity API v2 のテナント名を定義します。
`url`	String	外部プロバイダーの URL アドレスを定義します。
`username`	String	認証プロセス中に使用されるユーザー名を定義します。

7.202.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

7.202.2. tenant-name
リンクのコピー

OpenStack Identity API v2.0 のテナント名を定義します。

Expand

表7.270 リンクの概要
名前	型	Summary
`authentication_keys`	OpenstackVolumeAuthenticationKey[]
`certificates`	Certificate[]
`data_center`	DataCenter
`volume_types`	OpenStackVolumeType[]

7.203. OpenStackVolumeType struct
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表7.271 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`properties`	Property[]

Expand

表7.272 リンクの概要
名前	型	Summary
`openstack_volume_provider`	OpenStackVolumeProvider

7.204. OpenstackVolumeAuthenticationKey struct
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表7.273 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`creation_date`	日付
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`usage_type`	OpenstackVolumeAuthenticationKeyUsageType
`uuid`	String
`value`	String

Expand

表7.274 リンクの概要
名前	型	Summary
`openstack_volume_provider`	OpenStackVolumeProvider

7.205. OpenstackVolumeAuthenticationKeyUsageType enum
リンクのコピー

Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられました。

Expand

表7.275 値の概要
名前	Summary
`ceph`

7.206. OperatingSystem struct
リンクのコピー

オペレーティングシステムを説明する情報。これは、仮想マシンとホストの両方に使用されます。

Expand

表7.276 属性の概要
名前	型	Summary
`boot`	Boot	ブートシーケンスの設定。
`cmdline`	String	Linux オペレーティングシステムを使用している場合に、仮想マシンを起動するためのカスタムカーネルパラメーター。
`custom_kernel_cmdline`	String	ホストカーネルコマンドラインのカスタム部分。
`initrd`	String	Linux オペレーティングシステムが使用されている場合は、ISO ストレージドメインのカスタム初期 RAM ディスクへのパス。
`kernel`	String	Linux オペレーティングシステムが使用されている場合は、ISO ストレージドメイン上のカスタムカーネルへのパス。
`reported_kernel_cmdline`	String	実行中のホストによって報告されるホストカーネルコマンドライン。
`type`	String	人間が判読できる形式のオペレーティングシステム名。
`version`	バージョン

7.206.1. boot
リンクのコピー

ブートシーケンスの設定。

注記

ホストには使用されません。

7.206.2. cmdline
リンクのコピー

Linux オペレーティングシステムを使用している場合に、仮想マシンを起動するためのカスタムカーネルパラメーター。

注記

ホストには使用されません。

7.206.3. custom_kernel_cmdline
リンクのコピー

ホストカーネルコマンドラインのカスタム部分。これは、既存のカーネルコマンドラインと統合されます。

この属性によって実装された変更を適用するには、ホストを再インストールしてから再起動する必要があります。

各ホストデプロイの手順を実行中に、前のホストデプロイの手順で追加されたカーネルパラメーターは grubby --update-kernel DEFAULT --remove-args <previous_custom_params> を使用して削除され、現在のカーネルコマンドラインのカスタマイズは grubby --update-kernel DEFAULT --args <custom_params> を使用して適用されます。Manager は、最後に適用されたカーネルパラメーターのカスタマイズを内部的に追跡します。

注記

この属性は現在、ホストに対してのみ使用されます。

7.206.4. initrd
リンクのコピー

Linux オペレーティングシステムが使用されている場合は、ISO ストレージドメインのカスタム初期 RAM ディスクへのパス。

例: iso://initramfs-3.10.0-514.6.1.el7.x86_64.img

注記

ホストには使用されません。

7.206.5. kernel
リンクのコピー

Linux オペレーティングシステムが使用されている場合は、ISO ストレージドメイン上のカスタムカーネルへのパス。

例: iso://vmlinuz-3.10.0-514.6.1.el7.x86_64.

注記

ホストには使用されません。

7.206.6. reported_kernel_cmdline
リンクのコピー

実行中のホストによって報告されるホストカーネルコマンドライン。

これは読み取り専用の属性です。この属性を変更しようとしても、黙って無視されます。

注記

この属性は現在、ホストに対してのみ使用されます。

7.206.7. type
リンクのコピー

人間が判読できる形式のオペレーティングシステム名。

たとえば、Fedora または RHEL などです。通常、オペレーティングシステムサービスによって返される名前の 1 つになります。

注記

ホストの読み取り専用。

7.207. OperatingSystemInfo struct
リンクのコピー

ゲストオペレーティングシステムを表します。

Expand

表7.277 属性の概要
名前	型	Summary
`architecture`	アーキテクチャー	オペレーティングシステムのアーキテクチャー
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`large_icon`	アイコン	ゲストオペレーティングシステムの大きなアイコン。
`name`	String	人間が判読できるプレーンテキストでの名前。
`small_icon`	アイコン	ゲストオペレーティングシステムの小さなアイコン。
`tpm_support`	TpmSupport	TPM サポートステータス。

7.207.1. large_icon
リンクのコピー

ゲストオペレーティングシステムの大きなアイコン。最大サイズ: 幅 150px、高さ 120px。

7.207.2. small_icon
リンクのコピー

ゲストオペレーティングシステムの小さなアイコン。最大サイズ: 幅 43px、高さ 43px。

7.208. Option 構造体
リンクのコピー

Expand

表7.278 属性の概要
名前	型	Summary
`name`	String
`type`	String
`value`	String

7.209. OsType enum
リンクのコピー

オペレーティングシステムの種類を表すタイプ。

警告

このタイプは、OperatingSystemInfo タイプの導入により非推奨になりました。オペレーティングシステムは、API の最上位コレクションとして利用できます: operating_systems。

エンドユーザーは、これらの値のいずれかを選択して、仮想マシンにインストールされているオペレーティングシステム (ゲストオペレーティングシステム) のタイプを宣言します。この宣言により、システムは仮想マシンの設定を調整して、ユーザーエクスペリエンスを向上させることができます。たとえば、システムはオペレーティングシステムに最適なデバイスを選択します。システムはユーザーの選択に依存しており、インストールされた実際のゲストオペレーティングシステムを確認して検証しないことに注意してください。

Expand

表7.279 値の概要
名前	Summary
`その他`	他の値で指定されていない、他のタイプのオペレーティングシステム。
`other_linux`	他の値で指定されたもの以外の Linux ディストリビューション。
`rhel_3`	Red Hat Enterprise Linux 3 32 ビット
`rhel_3x64`	Red Hat Enterprise Linux 3 64 ビット
`rhel_4`	Red Hat Enterprise Linux 4 32 ビット
`rhel_4x64`	Red Hat Enterprise Linux 4 64 ビット
`rhel_5`	Red Hat Enterprise Linux 5 32 ビット
`rhel_5x64`	Red Hat Enterprise Linux 5 64 ビット
`rhel_6`	Red Hat Enterprise Linux 6 32 ビット
`rhel_6x64`	Red Hat Enterprise Linux 6 64 ビット
`unassigned`	この値は、`other` にマッピングされる。
`windows_2003`	Windows 2003 32 ビット
`windows_2003x64`	Windows 2003 64 ビット
`windows_2008`	Windows 2008 32 ビット
`windows_2008r2x64`	Windows 2008 R2 64 ビット
`windows_2008x64`	Windows 2008 64 ビット
`windows_2012x64`	Windows 2012 64 ビット
`windows_7`	Windows 7 32 ビット
`windows_7x64`	Windows 7 64 ビット
`windows_8`	Windows 8 32 ビット
`windows_8x64`	Windows 8 64 ビット
`windows_xp`	Windows XP.

7.210. Package struct
リンクのコピー

パッケージを表すタイプ。

これは、package 要素の例です。

<package>
  <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
</package>

<package>
  <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
</package>

Copy to Clipboard

Toggle word wrap

Expand

表7.280 属性の概要
名前	型	Summary
`name`	String	パッケージの名前

7.211. ParallelMigrationsPolicy enum
リンクのコピー

並行移行の接続ポリシーを表すタイプ。

Expand

表7.281 値の概要
名前	Summary
`auto`	並列接続と非並列接続を自動的に選択します。
`auto_parallel`	並列接続を使用し、それらの数を自動的に選択します。
`custom`	手動で指定した数の並列接続を使用します。
`disabled`	非並列接続を使用します。
`inherit`	クラスター値を使用します (仮想マシンにのみ適用可能)。

7.211.1. auto
リンクのコピー

並列接続と非並列接続を自動的に選択します。並列接続が使用されている場合、それらの数が自動的に選択されます。

7.211.2. custom
リンクのコピー

手動で指定した数の並列接続を使用します。並列接続の数は、MigrationOptions.customParallelMigrations で設定する必要があります。

7.212. Payload struct
リンクのコピー

Expand

表7.282 属性の概要
名前	型	Summary
`files`	File[]
`type`	VmDeviceType
`volume_id`	String

7.213. PayloadEncoding enum
リンクのコピー

Expand

表7.283 値の概要
名前	Summary
`base64`
`plaintext`

7.214. Permission struct
リンクのコピー

タイプはパーミッションを表します。

Expand

表7.284 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.285 リンクの概要
名前	型	Summary
`cluster`	クラスター	クラスターへの参照。
`data_center`	DataCenter	データセンターへの参照。
`disk`	ディスク	ディスクへの参照。
`group`	グループ	グループへの参照。
`host`	ホスト	ホストへの参照。
`role`	ロール	ロールへの参照。
`storage_domain`	StorageDomain	ストレージドメインへの参照。
`template`	テンプレート	テンプレートへの参照。
`user`	User	ユーザーへの参照。
`vm`	Vm	仮想マシンへの参照。
`vm_pool`	VmPool	仮想マシンプールへの参照。

7.215. Permit 構造体
リンクのコピー

タイプは permit を表します。

Expand

表7.286 属性の概要
名前	型	Summary
`administrative`	ブール値	permit が管理上のものかどうかを指定します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.287 リンクの概要
名前	型	Summary
`role`	ロール	permit が属するロールへの参照。

7.216. PmProxy 構造体
リンクのコピー

Expand

表7.288 属性の概要
名前	型	Summary
`type`	PmProxyType

7.217. PmProxyType enum
リンクのコピー

Expand

表7.289 値の概要
名前	Summary
`cluster`	フェンスプロキシーは、フェンスされたホストと同じクラスターから選択されます。
`dc`	フェンスプロキシーは、フェンスされたホストと同じデータセンターから選択されます。
`other_dc`	フェンスプロキシーは、フェンスされたホストとは異なるデータセンターから選択されます。

7.218. PolicyUnitType enum
リンクのコピー

すべての内部ポリシーユニットタイプのタイプを保持します。

Expand

表7.290 値の概要
名前	Summary
`filter`
`load_balancing`
`重量`

7.219. PortMirroring struct
リンクのコピー

7.220. PowerManagement struct
リンクのコピー

Expand

表7.291 属性の概要
名前	型	Summary
`address`	String	ホストのホスト名または IP アドレスです。
`agents`	Agent[]	複数のフェンスが使用されている場合のフェンスエージェントオプションを指定します。
`automatic_pm_enabled`	ブール値	エネルギーを節約するために、ホストの自動電源制御を切り替えます。
`enabled`	ブール値	電源管理設定が有効か無効かを示します。
`kdump_detection`	ブール値	ホストをシャットダウンする前に、ホスト上で kdump が実行されているかどうかを判断するかどうかを切り替えます。
`options`	Option[]	オプション name="" および value="" 文字列で指定された、選択した type= のフェンシングオプション。
`password`	String	電源管理用の有効で堅牢なパスワード。
`pm_proxies`	PmProxy[]	電源管理プロキシーを決定します。
`status`	PowerManagementStatus	ホストの電源ステータスを決定します。
`type`	String	フェンシングデバイスのコード。
`username`	String	電源管理用の有効なユーザー名。

7.220.1. agents
リンクのコピー

複数のフェンスが使用されている場合のフェンスエージェントオプションを指定します。

order サブ要素を使用して、フェンスエージェントに優先順位を付けます。エージェントは、フェンスアクションが成功するまで、その順序に従って順次実行されます。2 つ以上のフェンスエージェントの順序が同じ場合、それらは同時に実行されます。その他のサブ要素には、type、ip、user、password、および options が含まれます。

7.220.2. automatic_pm_enabled
リンクのコピー

エネルギーを節約するために、ホストの自動電源制御を切り替えます。true に設定すると、クラスターの負荷が低い場合にホストの電源が自動的にオフになり、必要に応じて再び電源がオンになります。これは、ユーザーが無効にしない限り、ホスト作成時に true に設定されます。

7.220.3. kdump_detection
リンクのコピー

ホストをシャットダウンする前に、ホスト上で kdump が実行されているかどうかを判断するかどうかを切り替えます。true に設定すると、ホストは kdump プロセス中にシャットダウンしません。これは、ユーザーが無効にしない限り、ホストで電源管理が有効になっている場合に true に設定されます。

7.220.4. type
リンクのコピー

フェンシングデバイスのコード。

有効なフェンシングデバイスコードのリストは、capabilities コレクションにあります。

7.221. PowerManagementStatus enum
リンクのコピー

Expand

表7.292 値の概要
名前	Summary
`off`	ホストは OFF です。
`on`	ホストが ON です。
`unknown`	不明なステータス。

7.222. Product 構造体
リンクのコピー

Expand

表7.293 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

7.223. ProductInfo struct
リンクのコピー

製品情報です。

エントリーポイントには、API ユーザーが Red Hat Virtualization 環境の正当性を判断するのに役立つ product_info 要素が含まれています。これには、製品名、vendor、version 含まれます。

本物の Red Hat Virtualization 環境を検証する

以下の要素は、本物の Red Hat Virtualization 環境を識別します。

<api>
...
<product_info>
  <name>oVirt Engine</name>
  <vendor>ovirt.org</vendor>
  <version>
    <build>0</build>
    <full_version>4.1.0_master</full_version>
    <major>4</major>
    <minor>1</minor>
    <revision>0</revision>
  </version>
</product_info>
...
</api>

<api>
...
<product_info>
  <name>oVirt Engine</name>
  <vendor>ovirt.org</vendor>
  <version>
    <build>0</build>
    <full_version>4.1.0_master</full_version>
    <major>4</major>
    <minor>1</minor>
    <revision>0</revision>
  </version>
</product_info>
...
</api>

Copy to Clipboard

Toggle word wrap

Expand

表7.294 属性の概要
名前	型	Summary
`instance_id`	String	製品のこの特定のインストールの ID。
`name`	String	`oVirt Engine` などの製品名です。
`vendor`	String	ベンダーの名前 (例: `ovirt)。
`version`	バージョン	製品のバージョン番号。

7.223.1. vendor
リンクのコピー

ベンダーの名前 (例: ovirt.org)。

7.224. ProfileDetail struct
リンクのコピー

Expand

表7.295 属性の概要
名前	型	Summary
`block_statistics`	BlockStatistic[]
`duration`	Integer
`fop_statistics`	FopStatistic[]
`profile_type`	String
`statistics`	Statistic[]

7.225. Property struct
リンクのコピー

Expand

表7.296 属性の概要
名前	型	Summary
`name`	String
`value`	String

7.226. ProxyTicket struct
リンクのコピー

Expand

表7.297 属性の概要
名前	型	Summary
`value`	String

7.227. QcowVersion enum
リンクのコピー

QCOW バージョンは、ボリュームがサポートする qemu バージョンを qemu に指定します。

このフィールドは更新 API を使用して更新でき、QCOW ボリュームについてのみ報告されます。これは、ディスクが作成されたストレージドメインのバージョンによって決まります。V4 より前のバージョンのストレージドメインは QCOW2 バージョン 2 ボリュームをサポートしますが、V4 ストレージドメインは QCOW2 バージョン 3 もサポートします。異なる QCOW バージョンの機能の詳細は、こちらを参照してください。

Expand

表7.298 値の概要
名前	Summary
`qcow2_v2`	Copy On Write のデフォルトの互換性バージョン。これは、どの QEMU でも使えるということを意味します。
`qcow2_v3`	QEMU 1 で導入された Copy On Write 互換バージョン。

7.227.1. qcow2_v3
リンクのコピー

QEMU 1.1 で導入された Copy On Write 互換バージョン。これは、新しいフォーマットが使用されていることを意味します。

7.228. Qos struct
リンクのコピー

このタイプは、サービスの品質 (QoS) を定義する属性を表します。

ストレージの type は storage で、属性 max_throughput、max_read_throughput、max_write_throughput、max_iops、max_read_iops および max_write_iops が関連しています。

コンピューティング機能を持つリソースの場合、type は cpu で、属性 cpu_limit が関連しています。

仮想マシンネットワークの type は network で、属性 inbound_average、inbound_peak、inbound_burst、outbound_average、outbound_peak、および outbound_burst が関連しています。

ホストネットワークの場合、type は hostnetwork で、属性 outbound_average_linkshare、outbound_average_upperlimit、および outbound_average_realtime が関連しています。

Expand

表7.299 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`cpu_limit`	Integer	最大処理能力 (単位: %)。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`inbound_average`	Integer	Mbps (メガビット/秒) 単位の望ましい平均インバウンドビットレート。
`inbound_burst`	Integer	1 回のバーストで配信できるデータの量 (MB 単位)。
`inbound_peak`	Integer	Mbps (メガビット/秒) 単位の最大インバウンドレート。
`max_iops`	Integer	1 秒あたりの最大許容入出力操作数。
`max_read_iops`	Integer	1 秒あたりの最大許容入力操作数。
`max_read_throughput`	Integer	読み取り操作の最大許容スループット。
`max_throughput`	Integer	最大許容総スループット。
`max_write_iops`	Integer	1 秒あたりの最大許容出力操作数。
`max_write_throughput`	Integer	書き込み操作の最大許容スループット。
`name`	String	人間が判読できるプレーンテキストでの名前。
`outbound_average`	Integer	Mbps (メガビット/秒) 単位の望ましい平均アウトバウンドビットレート。
`outbound_average_linkshare`	Integer	重み共有。
`outbound_average_realtime`	Integer	Mbps (メガビット/秒) 単位のコミットされたレート。
`outbound_average_upperlimit`	Integer	Mbps (メガビット/秒) 単位のネットワークで使用される最大帯域幅。
`outbound_burst`	Integer	MB 単位の 1 回のバーストで送信できるデータの量。
`outbound_peak`	Integer	Mbps (メガビット/秒) 単位の最大アウトバウンドレート。
`type`	QosType	このエントリーに割り当てることができるリソースの種類。

7.228.1. cpu_limit
リンクのコピー

最大処理能力 (単位: %)。

コンピューティングリソースの設定に使用されます。

7.228.2. inbound_average
リンクのコピー

Mbps (メガビット/秒) 単位の望ましい平均インバウンドビットレート。

仮想マシンのネットワークを設定するために使用します。定義されている場合、inbound_peak と inbound_burst も設定される必要があります。

詳細は、Libvirt-QOS を参照してください。

7.228.3. inbound_burst
リンクのコピー

1 回のバーストで配信できるデータの量 (MB 単位)。

仮想マシンのネットワークを設定するために使用します。定義されている場合、inbound_average と inbound_peak も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

7.228.4. inbound_peak
リンクのコピー

Mbps (メガビット/秒) 単位の最大インバウンドレート。

仮想マシンのネットワークを設定するために使用します。定義されている場合、inbound_average と inbound_burst も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

7.228.5. max_iops
リンクのコピー

1 秒あたりの最大許容入出力操作数。

ストレージの設定に使用されます。max_read_iops または max_write_iops が設定されている場合、設定することはできません。

7.228.6. max_read_iops
リンクのコピー

1 秒あたりの最大許容入力操作数。

ストレージの設定に使用されます。max_iops が設定されている場合、設定することはできません。

7.228.7. max_read_throughput
リンクのコピー

読み取り操作の最大許容スループット。

ストレージの設定に使用されます。max_throughput が設定されている場合は、設定することはできません。

7.228.8. max_throughput
リンクのコピー

最大許容総スループット。

ストレージの設定に使用されます。max_read_throughput または max_write_throughput が設定されている場合、設定することはできません。

7.228.9. max_write_iops
リンクのコピー

1 秒あたりの最大許容出力操作数。

ストレージの設定に使用されます。max_iops が設定されている場合、設定することはできません。

7.228.10. max_write_throughput
リンクのコピー

書き込み操作の最大許容スループット。

ストレージの設定に使用されます。max_throughput が設定されている場合は、設定することはできません。

7.228.11. outbound_average
リンクのコピー

Mbps (メガビット/秒) 単位の望ましい平均アウトバウンドビットレート。

仮想マシンのネットワークを設定するために使用します。定義されている場合、outbound_peak と outbound_burst も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

7.228.12. outbound_average_linkshare
リンクのコピー

重み共有。

ホストネットワークの設定に使用されます。同じ論理リンクリンクにアタッチされた他のネットワークと比較して、特定のネットワークに割り当てる必要がある論理リンクの容量を指定します。正確な共有は、そのリンクの全ネットワークの共有の合計によって異なります。デフォルトでは、この値は 1-100 の範囲の数字になります。

7.228.13. outbound_average_realtime
リンクのコピー

Mbps (メガビット/秒) 単位のコミットされたレート。

ホストネットワークの設定に使用されます。ネットワークに必要な最小帯域幅。要求される Committed Rate は保証されず、ネットワークインフラストラクチャーおよび同じ論理リンクの他のネットワークによって要求される Committed Rate によって異なります。

7.228.14. outbound_average_upperlimit
リンクのコピー

Mbps (メガビット/秒) 単位のネットワークで使用される最大帯域幅。

ホストネットワークの設定に使用されます。outboundAverageUpperlimit と outbound_average_realtime が提供される場合、outbound_averageUpperlimit は outbound_average_realtime より低くすることはできません。

詳細は、Libvirt-QOS を参照してください。

7.228.15. outbound_burst
リンクのコピー

MB 単位の 1 回のバーストで送信できるデータの量。

仮想マシンのネットワークを設定するために使用します。定義されている場合は、outbound_average と outbound_peak も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

7.228.16. outbound_peak
リンクのコピー

Mbps (メガビット/秒) 単位の最大アウトバウンドレート。

仮想マシンのネットワークを設定するために使用します。定義されている場合、outbound_average と outbound_burst も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

Expand

表7.300 リンクの概要
名前	型	Summary
`data_center`	DataCenter	QoS が関連付けられているデータセンター。

7.229. QosType enum
リンクのコピー

このタイプは、Quality of service (QoS) を割り当てることができるリソースのタイプを表します。

Expand

表7.301 値の概要
名前	Summary
`cpu`	Quality of service (QoS) は、コンピューティング機能を持つリソースに割り当てることができます。
`hostnetwork`	Quality of service (QoS) は、ホストネットワークに割り当てることができます。
`network`	Quality of service (QoS) は、仮想マシンネットワークに割り当てることができます。
`storage`	Quality of service (QoS) は、ストレージに割り当てることができます。

7.230. Quota 構造体
リンクのコピー

クォータオブジェクトを表します。

クォータの XML 表現の例:

<quota href="/ovirt-engine/api/datacenters/7044934e/quotas/dcad5ddc" id="dcad5ddc">
  <name>My Quota</name>
  <description>A quota for my oVirt environment</description>
  <cluster_hard_limit_pct>0</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>0</cluster_soft_limit_pct>
  <data_center href="/ovirt-engine/api/datacenters/7044934e" id="7044934e"/>
  <storage_hard_limit_pct>0</storage_hard_limit_pct>
  <storage_soft_limit_pct>0</storage_soft_limit_pct>
</quota>

<quota href="/ovirt-engine/api/datacenters/7044934e/quotas/dcad5ddc" id="dcad5ddc">
  <name>My Quota</name>
  <description>A quota for my oVirt environment</description>
  <cluster_hard_limit_pct>0</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>0</cluster_soft_limit_pct>
  <data_center href="/ovirt-engine/api/datacenters/7044934e" id="7044934e"/>
  <storage_hard_limit_pct>0</storage_hard_limit_pct>
  <storage_soft_limit_pct>0</storage_soft_limit_pct>
</quota>

Copy to Clipboard

Toggle word wrap

Expand

表7.302 属性の概要
名前	型	Summary
`cluster_hard_limit_pct`	Integer
`cluster_soft_limit_pct`	Integer
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`data_center`	DataCenter
`description`	String	プレーンテキストでの人間が判読できる説明。
`disks`	Disk[]
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`storage_hard_limit_pct`	Integer
`storage_soft_limit_pct`	Integer
`ユーザー`	User[]
`vms`	Vm[]

Expand

表7.303 リンクの概要
名前	型	Summary
`permissions`	Permission[]
`quota_cluster_limits`	QuotaClusterLimit[]
`quota_storage_limits`	QuotaStorageLimit[]

7.231. QuotaClusterLimit struct
リンクのコピー

Expand

表7.304 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`memory_limit`	10 進数
`memory_usage`	10 進数
`name`	String	人間が判読できるプレーンテキストでの名前。
`vcpu_limit`	Integer
`vcpu_usage`	Integer

Expand

表7.305 リンクの概要
名前	型	Summary
`cluster`	クラスター
`quota`	クォータ

7.232. QuotaModeType enum
リンクのコピー

Expand

表7.306 値の概要
名前	Summary
`audit`
`disabled`
`enabled`

7.233. QuotaStorageLimit struct
リンクのコピー

Expand

表7.307 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`limit`	Integer
`name`	String	人間が判読できるプレーンテキストでの名前。
`使用方法`	10 進数

Expand

表7.308 リンクの概要
名前	型	Summary
`quota`	クォータ
`storage_domain`	StorageDomain

7.234. Range 構造体
リンクのコピー

Expand

表7.309 属性の概要
名前	型	Summary
`from`	String
`to`	String

7.235. Rate 構造体
リンクのコピー

乱数ジェネレーターデバイスからの最大バイト消費速度を決定します。

Expand

表7.310 属性の概要
名前	型	Summary
`bytes`	Integer	期間ごとに消費できるバイト数。
`period`	Integer	1 期間の長さ (ミリ秒単位)。

7.236. RegistrationAffinityGroupMapping 構造体
リンクのコピー

このタイプは、オブジェクト登録の一部としてアフィニティーグループをマッピングする方法を説明します。オブジェクトは、仮想マシン、テンプレートなどにすることができます。

このマッピングを使用した XML 表現の例:

<action>
  <registration_configuration>
    <affinity_group_mappings>
     <registration_affinity_group_mapping>
       <from>
         <name>affinity</name>
       </from>
       <to>
         <name>affinity2</name>
       </to>
     </registration_affinity_group_mapping>
    </affinity_group_mappings>
  </registration_configuration>
</action>

<action>
  <registration_configuration>
    <affinity_group_mappings>
     <registration_affinity_group_mapping>
       <from>
         <name>affinity</name>
       </from>
       <to>
         <name>affinity2</name>
       </to>
     </registration_affinity_group_mapping>
    </affinity_group_mappings>
  </registration_configuration>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表7.311 リンクの概要
名前	型	Summary
`from`	AffinityGroup	元のアフィニティーグループへの参照。
`to`	AffinityGroup	宛先アフィニティーグループへの参照。

7.236.1. from
リンクのコピー

元のアフィニティーグループへの参照。name を使用して指定できます。

7.237. RegistrationAffinityLabelMapping 構造体
リンクのコピー

このタイプは、オブジェクト登録の一部としてアフィニティーラベルをマッピングする方法を説明します。オブジェクトは、仮想マシン、テンプレートなどにすることができます。

マッピングを使用した XML 表現の例:

<action>
  <registration_configuration>
    <affinity_label_mappings>
     <registration_affinity_label_mapping>
       <from>
         <name>affinity_label</name>
       </from>
       <to>
         <name>affinity_label2</name>
       </to>
     </registration_affinity_label_mapping>
    </affinity_label_mappings>
  </registration_configuration>
</action>

<action>
  <registration_configuration>
    <affinity_label_mappings>
     <registration_affinity_label_mapping>
       <from>
         <name>affinity_label</name>
       </from>
       <to>
         <name>affinity_label2</name>
       </to>
     </registration_affinity_label_mapping>
    </affinity_label_mappings>
  </registration_configuration>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表7.312 リンクの概要
名前	型	Summary
`from`	AffinityLabel	元のアフィニティーラベルへの参照。
`to`	AffinityLabel	宛先アフィニティーラベルへの参照。

7.237.1. from
リンクのコピー

元のアフィニティーラベルへの参照。name を使用して指定できます。

7.238. RegistrationClusterMapping 構造体
リンクのコピー

このタイプは、オブジェクト登録の一部としてクラスターをマッピングする方法を説明します。オブジェクトは、仮想マシン、テンプレートなどにすることができます。

このマッピングを使用した XML 表現の例:

<action>
  <registration_configuration>
    <cluster_mappings>
      <registration_cluster_mapping>
        <from>
          <name>myoriginalcluster</name>
        </from>
        <to>
          <name>mynewcluster</name>
        </to>
      </registration_cluster_mapping>
    </cluster_mappings>
  </registration_configuration>
</action>

<action>
  <registration_configuration>
    <cluster_mappings>
      <registration_cluster_mapping>
        <from>
          <name>myoriginalcluster</name>
        </from>
        <to>
          <name>mynewcluster</name>
        </to>
      </registration_cluster_mapping>
    </cluster_mappings>
  </registration_configuration>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表7.313 リンクの概要
名前	型	Summary
`from`	クラスター	元のクラスターへの参照。
`to`	クラスター	宛先クラスターへの参照。

7.238.1. from
リンクのコピー

元のクラスターへの参照。id または name を使用して指定できます。

7.238.2. to
リンクのコピー

宛先クラスターへの参照。id または name を使用して指定できます。

7.239. RegistrationConfiguration 構造体
リンクのコピー

このタイプは、オブジェクト (仮想マシン、テンプレートなど) の登録方法を記述し、障害復旧ソリューションの実装に使用されます。

このタイプに含まれる各マッピングを使用して、元のシステムのオブジェクトを、仮想マシンまたはテンプレートが登録されているシステムの対応するオブジェクトにマップできます。たとえば、クラスター A で設定された仮想マシンを使用したプライマリーセットアップと、クラスター B を使用したアクティブなセカンダリーセットアップが存在するとします。クラスター B はその仮想マシンと互換性があり、障害復旧シナリオにおいてストレージドメインをセカンダリーセットアップにインポートし、ユーザーが仮想マシンをクラスター B に登録できます。

その場合、クラスターマッピングを定義することで、回復プロセスを自動化できます。エンティティーが登録されると、その OVF はそれがクラスター A に属していることを示しますが、マッピングはクラスター A がクラスター B に置き換えられることを示します。Red Hat Virtualization Manager は切り替えを行い、仮想マシンをセカンダリーサイトのクラスター B に登録する必要があります。

クラスターマッピングは一例に過ぎず、さまざまな種類のマッピングがあります。

クラスターマッピング。
LUN マッピング。
ロールマッピング
ドメインマッピング
パーミッションのマッピング。
アフィニティーグループのマッピング。
アフィニティーラベルのマッピング。
仮想 NIC プロファイルのマッピング。

Red Hat Virtualization Manager で登録操作が行われると、各マッピングは特定の OVF のデータに使用されます。

マッピングを使用した XML 表現の例:

<action>
  <registration_configuration>
    <cluster_mappings>
      <registration_cluster_mapping>
        <from>
          <name>myoriginalcluster</name>
        </from>
        <to>
          <name>mynewcluster</name>
        </to>
      </registration_cluster_mapping>
    </cluster_mappings>
    <role_mappings>
      <registration_role_mapping>
        <from>
          <name>SuperUser</name>
        </from>
        <to>
          <name>UserVmRunTimeManager</name>
        </to>
      </registration_role_mapping>
    </role_mappings>
    <domain_mappings>
      <registration_domain_mapping>
        <from>
          <name>redhat</name>
        </from>
        <to>
          <name>internal</name>
        </to>
      </registration_domain_mapping>
    </domain_mappings>
    <lun_mappings>
     <registration_lun_mapping>
       <from id="111">
       </from>
       <to id="222">
         <alias>weTestLun</alias>
         <lun_storage>
           <type>iscsi</type>
           <logical_units>
              <logical_unit id="36001405fb1ddb4b91e44078f1fffcfef">
                 <address>44.33.11.22</address>
                 <port>3260</port>
                 <portal>1</portal>
                 <target>iqn.2017-11.com.name.redhat:444</target>
              </logical_unit>
           </logical_units>
         </lun_storage>
       </to>
     </registration_lun_mapping>
    </lun_mappings>
    <affinity_group_mappings>
     <registration_affinity_group_mapping>
       <from>
         <name>affinity</name>
       </from>
       <to>
         <name>affinity2</name>
       </to>
     </registration_affinity_group_mapping>
    </affinity_group_mappings>
    <affinity_label_mappings>
     <registration_affinity_label_mapping>
       <from>
         <name>affinity_label</name>
       </from>
       <to>
         <name>affinity_label2</name>
       </to>
     </registration_affinity_label_mapping>
    </affinity_label_mappings>
    <vnic_profile_mappings>
      <registration_vnic_profile_mapping>
        <from>
          <name>gold</name>
          <network>
            <name>red</name>
          </network>
        </from>
        <to id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
      </registration_vnic_profile_mapping>
      <registration_vnic_profile_mapping>
        <from>
          <name>silver</name>
          <network>
            <name>blue</name>
          </network>
        </from>
        <to>
          <name>copper</name>
          <network>
            <name>orange</name>
          </network>
        </to>
      </registration_vnic_profile_mapping>
    </vnic_profile_mappings>
  </registration_configuration>
</action>

<action>
  <registration_configuration>
    <cluster_mappings>
      <registration_cluster_mapping>
        <from>
          <name>myoriginalcluster</name>
        </from>
        <to>
          <name>mynewcluster</name>
        </to>
      </registration_cluster_mapping>
    </cluster_mappings>
    <role_mappings>
      <registration_role_mapping>
        <from>
          <name>SuperUser</name>
        </from>
        <to>
          <name>UserVmRunTimeManager</name>
        </to>
      </registration_role_mapping>
    </role_mappings>
    <domain_mappings>
      <registration_domain_mapping>
        <from>
          <name>redhat</name>
        </from>
        <to>
          <name>internal</name>
        </to>
      </registration_domain_mapping>
    </domain_mappings>
    <lun_mappings>
     <registration_lun_mapping>
       <from id="111">
       </from>
       <to id="222">
         <alias>weTestLun</alias>
         <lun_storage>
           <type>iscsi</type>
           <logical_units>
              <logical_unit id="36001405fb1ddb4b91e44078f1fffcfef">
                 <address>44.33.11.22</address>
                 <port>3260</port>
                 <portal>1</portal>
                 <target>iqn.2017-11.com.name.redhat:444</target>
              </logical_unit>
           </logical_units>
         </lun_storage>
       </to>
     </registration_lun_mapping>
    </lun_mappings>
    <affinity_group_mappings>
     <registration_affinity_group_mapping>
       <from>
         <name>affinity</name>
       </from>
       <to>
         <name>affinity2</name>
       </to>
     </registration_affinity_group_mapping>
    </affinity_group_mappings>
    <affinity_label_mappings>
     <registration_affinity_label_mapping>
       <from>
         <name>affinity_label</name>
       </from>
       <to>
         <name>affinity_label2</name>
       </to>
     </registration_affinity_label_mapping>
    </affinity_label_mappings>
    <vnic_profile_mappings>
      <registration_vnic_profile_mapping>
        <from>
          <name>gold</name>
          <network>
            <name>red</name>
          </network>
        </from>
        <to id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
      </registration_vnic_profile_mapping>
      <registration_vnic_profile_mapping>
        <from>
          <name>silver</name>
          <network>
            <name>blue</name>
          </network>
        </from>
        <to>
          <name>copper</name>
          <network>
            <name>orange</name>
          </network>
        </to>
      </registration_vnic_profile_mapping>
    </vnic_profile_mappings>
  </registration_configuration>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表7.314 属性の概要
名前	型	Summary
`affinity_group_mappings`	RegistrationAffinityGroupMapping[]	アフィニティーグループのマッピング方法を説明します。
`affinity_label_mappings`	RegistrationAffinityLabelMapping[]	アフィニティーラベルのマッピング方法を説明します。
`cluster_mappings`	RegistrationClusterMapping[]	オブジェクトが参照するクラスターのマッピング方法を説明します。
`domain_mappings`	RegistrationDomainMapping[]	ユーザーのドメインのマッピング方法を説明します。
`lun_mappings`	RegistrationLunMapping[]	LUN のマッピング方法を説明します。
`role_mappings`	RegistrationRoleMapping[]	ロールのマッピング方法を説明します。
`vnic_profile_mappings`	RegistrationVnicProfileMapping[]	登録プロセス中に適用される仮想 NIC プロファイルのマッピングルール。

7.240. RegistrationDomainMapping 構造体
リンクのコピー

このタイプは、オブジェクト登録の一部としてユーザーのドメインをマップする方法を説明します。オブジェクトは、仮想マシン、テンプレートなどにすることができます。注: これは、ユーザー名が同じであり、ドメイン名のみが変更されるという前提に基づいています。

このマッピングを使用した XML 表現の例:

<action>
  <registration_configuration>
    <domain_mappings>
      <registration_domain_mapping>
        <from>
          <name>redhat</name>
        </from>
        <to>
          <name>internal</name>
        </to>
      </registration_domain_mapping>
    </domain_mappings>
  </registration_configuration>
</action>

<action>
  <registration_configuration>
    <domain_mappings>
      <registration_domain_mapping>
        <from>
          <name>redhat</name>
        </from>
        <to>
          <name>internal</name>
        </to>
      </registration_domain_mapping>
    </domain_mappings>
  </registration_configuration>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表7.315 リンクの概要
名前	型	Summary
`from`	ドメイン	元のドメインへの参照。
`to`	ドメイン	宛先ドメインへの参照。

7.240.1. from
リンクのコピー

元のドメインへの参照。name を使用して指定できます。

7.241. RegistrationLunMapping 構造体
リンクのコピー

このタイプは、オブジェクト登録の一部として LUN をマップする方法を示します。オブジェクトは、仮想マシン、テンプレートなどにすることができます。

外部 LUN ディスクは、ストレージドメインに存在しないエンティティーです。オブジェクトが登録されている環境に存在する必要がないため、指定する必要があります。このマッピングを使用した XML 表現の例:

<action>
  <registration_configuration>
    <lun_mappings>
      <registration_lun_mapping>
    <lun_mappings>
     <registration_lun_mapping>
       <from id="111">
       </from>
       <to id="222">
         <alias>weTestLun</alias>
         <lun_storage>
           <type>iscsi</type>
           <logical_units>
              <logical_unit id="36001405fb1ddb4b91e44078f1fffcfef">
                 <address>44.33.11.22</address>
                 <port>3260</port>
                 <portal>1</portal>
                 <target>iqn.2017-11.com.name.redhat:444</target>
              </logical_unit>
           </logical_units>
         </lun_storage>
       </to>
     </registration_lun_mapping>
    </lun_mappings>
  </registration_configuration>
</action>

<action>
  <registration_configuration>
    <lun_mappings>
      <registration_lun_mapping>
    <lun_mappings>
     <registration_lun_mapping>
       <from id="111">
       </from>
       <to id="222">
         <alias>weTestLun</alias>
         <lun_storage>
           <type>iscsi</type>
           <logical_units>
              <logical_unit id="36001405fb1ddb4b91e44078f1fffcfef">
                 <address>44.33.11.22</address>
                 <port>3260</port>
                 <portal>1</portal>
                 <target>iqn.2017-11.com.name.redhat:444</target>
              </logical_unit>
           </logical_units>
         </lun_storage>
       </to>
     </registration_lun_mapping>
    </lun_mappings>
  </registration_configuration>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表7.316 リンクの概要
名前	型	Summary
`from`	ディスク	元の LUN への参照。
`to`	ディスク	仮想マシンに追加される LUN への参照。

7.241.1. from
リンクのコピー

元の LUN への参照。これは、id 属性で指定する必要があります。

7.242. RegistrationRoleMapping 構造体
リンクのコピー

このタイプは、オブジェクト登録の一部としてロールをマップする方法を記述します。オブジェクトは、仮想マシン、テンプレートなどにすることができます。

ロールマッピングは、プライマリーサイトとセカンダリーサイトの間の相関するロールをマップすることを目的としています。たとえば、登録されている仮想マシンに対して、ロール UserVmRunTimeManager を持つパーミッションがある場合があります。したがって、UserVmRunTimeManager の代わりに SuperUser ロールを使用して、仮想マシンをセカンダリーセットアップに登録するマッピングを送信することができます。このマッピングを使用した XML 表現の例:

<action>
  <registration_configuration>
    <role_mappings>
      <registration_eole_mapping>
        <from>
          <name>SuperUser</name>
        </from>
        <to>
          <name>UserVmRunTimeManager</name>
        </to>
      </registration_role_mapping>
    </role_mappings>
  </registration_configuration>
</action>

<action>
  <registration_configuration>
    <role_mappings>
      <registration_eole_mapping>
        <from>
          <name>SuperUser</name>
        </from>
        <to>
          <name>UserVmRunTimeManager</name>
        </to>
      </registration_role_mapping>
    </role_mappings>
  </registration_configuration>
</action>

Copy to Clipboard

Toggle word wrap

Expand

表7.317 リンクの概要
名前	型	Summary
`from`	ロール	元のロールへの参照。
`to`	ロール	宛先ロールへの参照。

7.242.1. from
リンクのコピー

元のロールへの参照。name を使用して指定できます。

7.243. RegistrationVnicProfileMapping struct
リンクのコピー

外部仮想 NIC プロファイルを Red Hat Virtualization Manager に存在するものにマップします。ターゲットは、プロファイル ID、またはプロファイル名とネットワーク名のペアとして指定できます。

たとえば、目的の仮想 NIC プロファイルマッピングに次の行が含まれているとします。

Expand

ソースネットワーク名	ソースネットワークプロファイル名	ターゲット仮想 NIC プロファイル ID\名
`red`	`gold`	`738dd914-8ec8-4a8b-8628-34672a5d449b`
`<empty>` (ネットワーク名なし)	`<empty>` (ネットワークプロファイル名なし)	`892a12ec-2028-4451-80aa-ff3bf55d6bac`
`blue`	`silver`	`orange\copper`
`yellow`	`platinum`	`<empty>` (プロファイルなし)
`green`	`bronze`

次に、次のスニペットを RegistrationConfiguration に追加する必要があります

<vnic_profile_mappings>
  <registration_vnic_profile_mapping>
    <from>
      <name>gold</name>
      <network>
        <name>red</name>
      </network>
    </from>
    <to id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name></name>
      <network>
        <name></name>
      </network>
    </from>
    <to id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>silver</name>
      <network>
        <name>blue</name>
      </network>
    </from>
    <to>
      <name>copper</name>
      <network>
        <name>orange</name>
      </network>
    </to>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>platinum</name>
      <network>
        <name>yellow</name>
      </network>
    </from>
    <to>
      <name></name>
      <network>
        <name></name>
      </network>
    </to>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>bronze</name>
      <network>
        <name>green</name>
      </network>
    </from>
  </registration_vnic_profile_mapping>
</vnic_profile_mappings>

<vnic_profile_mappings>
  <registration_vnic_profile_mapping>
    <from>
      <name>gold</name>
      <network>
        <name>red</name>
      </network>
    </from>
    <to id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name></name>
      <network>
        <name></name>
      </network>
    </from>
    <to id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>silver</name>
      <network>
        <name>blue</name>
      </network>
    </from>
    <to>
      <name>copper</name>
      <network>
        <name>orange</name>
      </network>
    </to>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>platinum</name>
      <network>
        <name>yellow</name>
      </network>
    </from>
    <to>
      <name></name>
      <network>
        <name></name>
      </network>
    </to>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>bronze</name>
      <network>
        <name>green</name>
      </network>
    </from>
  </registration_vnic_profile_mapping>
</vnic_profile_mappings>

Copy to Clipboard

Toggle word wrap

Expand

表7.318 リンクの概要
名前	型	Summary
`from`	VnicProfile	外部ネットワークおよび外部ネットワークプロファイルへの参照。
`to`	VnicProfile	既存の仮想 NIC プロファイルへの参照。

7.243.1. from
リンクのコピー

外部ネットワークおよび外部ネットワークプロファイルへの参照。どちらも name を使用して指定する必要があります。

7.243.2. to
リンクのコピー

既存の仮想 NIC プロファイルへの参照。name または id で指定する必要があります。name または id の両方ではなく、どちらか一方を指定します。

7.244. ReportedConfiguration 構造体
リンクのコピー

Expand

表7.319 属性の概要
名前	型	Summary
`actual_value`	String
`expected_value`	String
`in_sync`	ブール値	ネットワークアタッチメントにコミットされていないネットワーク設定が含まれている場合は `false`。
`name`	String

7.245. ReportedDevice 構造体
リンクのコピー

Expand

表7.320 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`ips`	Ip[]
`mac`	Mac
`name`	String	人間が判読できるプレーンテキストでの名前。
`type`	ReportedDeviceType

Expand

表7.321 リンクの概要
名前	型	Summary
`vm`	Vm

7.246. ReportedDeviceType enum
リンクのコピー

Expand

表7.322 値の概要
名前	Summary
`network`

7.247. ResolutionType enum
リンクのコピー

Expand

表7.323 値の概要
名前	Summary
`add`
`copy`

7.248. RngDevice 構造体
リンクのコピー

乱数ジェネレーター (RNG) デバイスモデル。

Expand

表7.324 属性の概要
名前	型	Summary
`rate`	Rate	乱数ジェネレーターデバイスからの最大バイト消費速度を決定します。
`source`	RngSource	乱数ジェネレーターデバイスのバックエンド。

7.249. RngSource enum
リンクのコピー

乱数ジェネレーターのバックエンドタイプを表します。

Expand

表7.325 値の概要
名前	Summary
`hwrng`	`/dev/hwrng` (通常は特殊な HW ジェネレーター) デバイスからランダムデータを取得します。
`random`	`/dev/random` デバイスからランダムデータを取得します。
`urandom`	`/dev/urandom` デバイスからランダムデータを取得します。

7.249.1. urandom
リンクのコピー

/dev/urandom デバイスからランダムデータを取得します。

この RNG ソースは、クラスターを認識しないエンティティー (つまり、空白のテンプレートとインスタンスタイプ) の random RNG ソースと、互換性バージョン 4.1 以降のクラスターに関連付けられたエンティティーを置き換えることを目的としています。

7.250. Role 構造体
リンクのコピー

システムロールを表します。

Expand

表7.326 属性の概要
名前	型	Summary
`administrative`	ブール値	ロールを管理専用にするかどうかを定義します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`mutable`	ブール値	ロールを更新または削除する機能を定義します。
`name`	String	人間が判読できるプレーンテキストでの名前。

7.250.1. mutable
リンクのコピー

ロールを更新または削除する機能を定義します。

mutable が false に設定されているロールは、定義済みのロールです。

Expand

表7.327 リンクの概要
名前	型	Summary
`permits`	Permit[]	ロール permits の permits サブコレクションへのリンク。
`user`	User

7.251. RoleType enum
リンクのコピー

ロールが管理ロールかどうかを表すタイプ。少なくとも 1 つの管理ロールを付与されたユーザーは、管理者と見なされます。

Expand

表7.328 値の概要
名前	Summary
`admin`	管理ロール。
`user`	ユーザーロール。

7.252. SchedulingPolicy struct
リンクのコピー

Expand

表7.329 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`default_policy`	ブール値
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`locked`	ブール値
`name`	String	人間が判読できるプレーンテキストでの名前。
`properties`	Property[]

Expand

表7.330 リンクの概要
名前	型	Summary
`balances`	Balance[]
`filters`	Filter[]
`重量`	Weight[]

7.253. SchedulingPolicyUnit struct
リンクのコピー

Expand

表7.331 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`enabled`	ブール値
`id`	String	一意の ID
`internal`	ブール値
`name`	String	人間が判読できるプレーンテキストでの名前。
`properties`	Property[]
`type`	PolicyUnitType

7.254. ScsiGenericIO enum
リンクのコピー

ダイレクト LUN ディスクが SCSI パススルーを使用している場合、権限 I/O ポリシーはこの enum によって決定されます。

Expand

表7.332 値の概要
名前	Summary
`disabled`	SCSI パススルーを無効にします。
`filtered`	特権 SCSI I/O を拒否します。
`unfiltered`	特権 SCSI I/O を許可します。

7.255. SeLinux 構造体
リンクのコピー

システム内の SELinux を表します。

Expand

表7.333 属性の概要
名前	型	Summary
`mode`	SeLinuxMode	SELinux の現在のモード。

7.256. SeLinuxMode enum
リンクのコピー

SELinux 強制モードを表します。

Expand

表7.334 値の概要
名前	Summary
`disabled`	SELinux はカーネルで無効になっています。
`enforcing`	SELinux が実行され、パーミッションを強制しています。
`permissive`	SELinux が実行され、ログを記録していますが、パーミッションが強制されていません。

7.257. SerialNumber 構造体
リンクのコピー

Expand

表7.335 属性の概要
名前	型	Summary
`policy`	SerialNumberPolicy
`value`	String

7.258. SerialNumberPolicy enum
リンクのコピー

シリアル番号のポリシーを表すタイプ。

Expand

表7.336 値の概要
名前	Summary
`custom`	このポリシーにより、ユーザーはシリアル番号として任意の文字列を指定できます。
`host`	このポリシーはレガシーポリシーです。
`none`	このポリシーは、シリアル番号ポリシーを削除し、デフォルトの null に移動するために使用されます。
`vm`	このポリシーでは、仮想マシン ID をシリアル番号として使用します。

7.258.1. host
リンクのコピー

このポリシーはレガシーポリシーです。シリアル番号としてホスト ID を使用します。

7.259. Session 構造体
リンクのコピー

仮想マシンへのユーザーセッションを説明します。

Expand

表7.337 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`console_user`	ブール値	これがコンソールセッションであるかどうかを示します。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`ip`	Ip	ユーザーの接続元 IP アドレス。
`name`	String	人間が判読できるプレーンテキストでの名前。
`protocol`	String	セッションで使用されるプロトコル。

7.259.1. console_user
リンクのコピー

これがコンソールセッションであるかどうかを示します。

コンソールユーザー (SPICE または VNC) の場合の値は true、その他 (RDP または SSH など) の場合は false になります。

7.259.2. ip
リンクのコピー

ユーザーの接続元 IP アドレス。

現在、コンソールユーザーのみが利用できます。

7.259.3. protocol
リンクのコピー

セッションで使用されるプロトコル。

現在使用されていません。SPICE、VNC、SSH、RDP など、ユーザーの接続方法に関する情報を対象としています。

Expand

表7.338 リンクの概要
名前	型	Summary
`user`	User	このセッションに関連するユーザー。
`vm`	Vm	このセッションに関連する仮想マシンへのリンク。

7.259.4. user
リンクのコピー

このセッションに関連するユーザー。

ユーザーがコンソールユーザーの場合、これは実際の Red Hat Virtualization ユーザーへのリンクです。それ以外の場合は、ユーザー名のみが提供されます。

7.260. SkipIfConnectivityBroken struct
リンクのコピー

Expand

表7.339 属性の概要
名前	型	Summary
`enabled`	ブール値	有効にすると、クラスター内の設定可能なパーセンテージを超えるホストが接続を失ってもホストのフェンシングは実行されません。
`threshold`	Integer	接続テストのしきい値。

7.260.1. enabled
リンクのコピー

7.260.2. threshold
リンクのコピー

接続テストのしきい値。少なくともクラスター内のホストのしきい値パーセンテージで接続が失われた場合、フェンシングは行われません。

7.261. SkipIfSdActive struct
リンクのコピー

このタイプは、フェンシングポリシーのストレージ関連の設定を表します。

Expand

表7.340 属性の概要
名前	型	Summary
`enabled`	ブール値	有効にすると、ホストがストレージでリースを維持している場合にフェンシングをスキップします。

7.261.1. enabled
リンクのコピー

7.262. Snapshot 構造体
リンクのコピー

スナップショットオブジェクトを表します。

XML 表現の例:

<snapshot id="456" href="/ovirt-engine/api/vms/123/snapshots/456">
  <actions>
    <link rel="restore" href="/ovirt-engine/api/vms/123/snapshots/456/restore"/>
  </actions>
  <vm id="123" href="/ovirt-engine/api/vms/123"/>
  <description>Virtual Machine 1 - Snapshot A</description>
  <type>active</type>
  <date>2010-08-16T14:24:29</date>
  <persist_memorystate>false</persist_memorystate>
</snapshot>

<snapshot id="456" href="/ovirt-engine/api/vms/123/snapshots/456">
  <actions>
    <link rel="restore" href="/ovirt-engine/api/vms/123/snapshots/456/restore"/>
  </actions>
  <vm id="123" href="/ovirt-engine/api/vms/123"/>
  <description>Virtual Machine 1 - Snapshot A</description>
  <type>active</type>
  <date>2010-08-16T14:24:29</date>
  <persist_memorystate>false</persist_memorystate>
</snapshot>

Copy to Clipboard

Toggle word wrap

Expand

表7.341 属性の概要
名前	型	Summary
`auto_pinning_policy`	AutoPinningPolicy	自動 CPU および NUMA 設定を適用するかどうか、およびその適用方法を指定します。
`bios`	Bios	仮想マシンの BIOS 設定への参照。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`console`	Console	この仮想マシン用に設定されたコンソール。
`cpu`	Cpu	仮想マシン CPU の設定。
`cpu_pinning_policy`	CpuPinningPolicy	CPU および NUMA 設定を適用するかどうか、またどのように適用するかを指定します。
`cpu_shares`	Integer
`creation_time`	日付	仮想マシンの作成日。
`custom_compatibility_version`	バージョン	仮想マシンのカスタム互換性バージョン。
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	さまざまなフックを設定するために VDSM に送信されるプロパティー。
`date`	日付	このスナップショットが作成された日付。
`delete_protected`	ブール値	`true` の場合、仮想マシンは削除できません。
`description`	String	プレーンテキストでの人間が判読できる説明。
`display`	表示	仮想マシンの表示設定。
`domain`	ドメイン	この仮想マシン用に設定されたドメイン。
`fqdn`	String	仮想マシンの完全修飾ドメイン名。
`guest_operating_system`	GuestOperatingSystem	仮想マシンにインストールされているオペレーティングシステム。
`guest_time_zone`	TimeZone	仮想マシンが使用するタイムゾーン (ゲストエージェントによって返されます)。
`has_illegal_images`	ブール値	仮想マシンに、ディスクが `ILLEGAL` 状態のスナップショットがあるかどうかを示します。
`high_availability`	高可用性	仮想マシンの高可用性設定。
`id`	String	一意の ID
`initialization`	初期化	仮想マシンの初期化設定への参照。
`io`	Io	IO スレッドのパフォーマンスチューニング用。
`large_icon`	アイコン	仮想マシンの大きなアイコン。
`lease`	StorageDomainLease	この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。
`memory`	Integer	仮想マシンのメモリー (バイト単位)。
`memory_policy`	MemoryPolicy	仮想マシンのメモリー管理設定への参照。
`migration`	MigrationOptions	実行中の仮想マシンの別のホストへの移行設定への参照。
`migration_downtime`	Integer	別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。
`multi_queues_enabled`	ブール値	`true` の場合、各仮想インターフェイスは、利用可能な仮想 CPU に応じて最適な数のキューを取得します。
`name`	String	人間が判読できるプレーンテキストでの名前。
`next_run_configuration_exists`	ブール値	仮想マシンの設定が変更されたため、仮想マシンの再起動が必要です。
`numa_tune_mode`	NumaTuneMode	NUMA トポロジーの適用方法。
`origin`	String	この仮想マシンのオリジン。
`os`	OperatingSystem	仮想マシンにインストールされているオペレーティングシステムのタイプ。
`payloads`	Payload[]	仮想マシンのオプションのペイロード。ISO が仮想マシンを設定するために使用されます。
`persist_memorystate`	ブール値	仮想マシンのメモリーの内容がスナップショットに含まれているかどうかを示します。
`placement_policy`	VmPlacementPolicy	仮想マシンの配置ポリシーの設定。
`rng_device`	RngDevice	この仮想マシンの乱数ジェネレーターデバイスの設定。
`run_once`	ブール値	`true` の場合、仮想マシンは run once コマンドを使用して開始されています。つまり、この 1 回の実行のために保存されている設定とは異なる可能性があります。
`serial_number`	SerialNumber	クラスター内の仮想マシンのシリアル番号。
`small_icon`	アイコン	仮想マシンの小さなアイコン。
`snapshot_status`	SnapshotStatus	スナップショットのステータス。
`snapshot_type`	SnapshotType	スナップショットのタイプ。
`soundcard_enabled`	ブール値	`true` の場合、サウンドカードが仮想マシンに追加されます。
`sso`	Sso	この仮想マシンが設定されているシングルサインオン設定への参照。
`start_paused`	ブール値	`true` の場合、仮想マシンは起動後、最初は 'paused' 状態になります。
`start_time`	日付	仮想マシンが起動された日付。
`stateless`	ブール値	`true` の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。
`status`	VmStatus	仮想マシンの現在の状態
`status_detail`	String	人間が読める現在のステータスの詳細。
`stop_reason`	String	仮想マシンが停止した理由。
`stop_time`	日付	仮想マシンが停止された日付。
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	ストレージエラー後に仮想マシンを再開する方法を決定します。
`time_zone`	TimeZone	oVirt によって設定された仮想マシンのタイムゾーン。
`tpm_enabled`	ブール値	`true` の場合、TPM デバイスが仮想マシンに追加されます。
`tunnel_migration`	ブール値	`true` の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。
`type`	VmType	仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。
`usb`	Usb	この仮想マシンの USB デバイスの設定 (カウント、タイプ)。
`use_latest_template_version`	ブール値	`true` の場合、仮想マシンは起動時にテンプレートの最新バージョンに再設定されます。
`virtio_scsi`	VirtioScsi	VirtIO SCSI 設定への参照。
`virtio_scsi_multi_queues`	Integer	このフィールドの Virtio-SCSI contoller のキュー数には virtioScsiMultiQueuesEnabled が true である必要があります。詳細は virtioScsiMultiQueuesEnabled を参照してください。
`virtio_scsi_multi_queues_enabled`	ブール値	`true` の場合、Virtio-SCSI デバイスは、使用可能な仮想 CPU とディスク、または指定された virtioScsiMultiQueues に応じて、いくつかの複数キューを取得します。

7.262.1. auto_pinning_policy
リンクのコピー

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

重要

7.262.2. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

Copy to Clipboard

Toggle word wrap

7.262.3. cpu_pinning_policy
リンクのコピー

7.262.4. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

7.262.5. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

7.262.6. initialization
リンクのコピー

仮想マシンの初期化設定への参照。

注記

Red Hat Virtualization 4.1.8 以降、このプロパティーは空のタグを送信することでクリアできます。

たとえば、initialization 属性をクリアするには、次のようなリクエストを送ります。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <initialization/>
</vm>

<vm>
  <initialization/>
</vm>

Copy to Clipboard

Toggle word wrap

このようなリクエストへのレスポンス、およびヘッダー All-Content: true を持つリクエストには、引き続きこの属性が含まれます。

7.262.7. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.262.8. lease
リンクのコピー

この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。

7.262.9. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>

<vm>
  <memory>1073741824</memory>
</vm>

Copy to Clipboard

Toggle word wrap

注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 2³⁰ バイト = 1073741824 バイト。

注記

Red Hat Virtualization Manager は内部的に値を切り捨てて整数の MiB (1MiB = 2²⁰ バイト) にします。

7.262.10. migration
リンクのコピー

実行中の仮想マシンの別のホストへの移行設定への参照。

注記

7.262.11. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

7.262.12. next_run_configuration_exists
リンクのコピー

仮想マシンの設定が変更されたため、仮想マシンの再起動が必要です。変更された設定は、仮想マシンの シャットダウン 処理時に適用されます。

7.262.13. numa_tune_mode
リンクのコピー

NUMA トポロジーの適用方法。非推奨となりました。vNUMA ノードごとの NUMA 調整が使用されます。

7.262.14. origin
リンクのコピー

この仮想マシンのオリジン。

値:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.262.15. persist_memorystate
リンクのコピー

仮想マシンのメモリーの内容がスナップショットに含まれているかどうかを示します。

スナップショットが作成されるときのデフォルト値は true です。

7.262.16. placement_policy
リンクのコピー

仮想マシンの配置ポリシーの設定。

この設定を更新して、仮想マシンを 1 つ以上のホストにピニングできます。

注記

たとえば、仮想マシンを 2 つのホストに固定するには、以下のリクエストを送信します。

PUT /api/vms/123

PUT /api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

Copy to Clipboard

Toggle word wrap

7.262.17. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.262.18. sso
リンクのコピー

7.262.19. stop_reason
リンクのコピー

仮想マシンが停止した理由。オプションで、仮想マシンをシャットダウンするときにユーザーが設定します。

7.262.20. tpm_enabled
リンクのコピー

Expand

表7.342 リンクの概要
名前	型	Summary
`affinity_labels`	AffinityLabel[]	オプション
`applications`	Application[]	仮想マシンにインストールされているアプリケーションのリスト。
`cdroms`	Cdrom[]	CDROM にマウントされた ISO への参照。
`cluster`	クラスター	仮想マシンが属するクラスターへの参照。
`cpu_profile`	CpuProfile	この仮想マシンによって使用される CPU プロファイルへの参照。
`disk_attachments`	DiskAttachment[]	仮想マシンにアタッチされているディスクへの参照。
`disks`	Disk[]	スナップショットにリンクされているディスクのリスト。
`dynamic_cpu`	DynamicCpu	仮想マシン CPU の動的設定。
`external_host_provider`	ExternalHostProvider
`floppies`	Floppy[]	フロッピーにマウントされた ISO への参照。
`graphics_consoles`	GraphicsConsole[]	この仮想マシン用に設定されたグラフィックコンソールのリスト。
`host`	ホスト	仮想マシンが実行されているホストへの参照。
`host_devices`	HostDevice[]	この仮想マシンに関連付けられているデバイスへの参照。
`instance_type`	InstanceType	仮想マシンの設定は、インスタンスタイプの 1 つを介してオプションで事前定義できます。
`katello_errata`	KatelloErratum[]	仮想マシンに割り当てられたすべての Katello エラータをリスト表示します。
`mediated_devices`	VmMediatedDevice[]	仲介デバイスの設定。
`nics`	Nic[]	仮想マシン上のネットワークインターフェイスデバイスのリストを参照します。
`numa_nodes`	NumaNode[]	この仮想マシンで使用される NUMA ノード設定を参照します。
`original_template`	テンプレート	仮想マシンの作成に使用された元のテンプレートを参照します。
`permissions`	Permission[]	この仮想マシンに設定されたパーミッション。
`quota`	クォータ	この仮想マシンに設定されたクォータ設定への参照。
`reported_devices`	ReportedDevice[]
`sessions`	Session[]	この仮想マシンに対して開かれているユーザーセッションのリスト。
`snapshots`	Snapshot[]	仮想マシンから取得されたすべてのスナップショットを参照します。
`statistics`	Statistic[]	この仮想マシンから収集された統計データ。
`storage_domain`	StorageDomain	仮想マシンが属するストレージドメインへの参照。
`tags`	Tag[]
`template`	テンプレート	仮想マシンがベースとするテンプレートへの参照。
`vm`	Vm	このスナップショットが取得された仮想マシン。
`vm_pool`	VmPool	仮想マシンが任意のメンバーであるプールへの参照。
`watchdogs`	Watchdog[]	ウォッチドッグ設定への参照。

7.262.21. affinity_labels
リンクのコピー

オプションサブクラスターのラベル付けに使用されます。

7.262.22. katello_errata
リンクのコピー

仮想マシンに割り当てられたすべての Katello エラータをリスト表示します。

GET /ovirt-engine/api/vms/123/katelloerrata

GET /ovirt-engine/api/vms/123/katelloerrata

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

Copy to Clipboard

Toggle word wrap

7.262.23. original_template
リンクのコピー

仮想マシンの作成に使用された元のテンプレートを参照します。

テンプレートまたは別の仮想マシンから仮想マシンをクローンした場合、template はブランクテンプレートにリンクし、履歴の追跡には original_template が使用されます。

それ以外の場合は、template と original_template は同じです。

7.262.24. statistics
リンクのコピー

この仮想マシンから収集された統計データ。

一部の統計、特に memory.buffered および memory.cached は、Red Hat Virtualization ゲストエージェントが仮想マシンにインストールされている場合にのみ使用できることに注意してください。

7.263. SnapshotStatus enum
リンクのコピー

スナップショットの現在のステータスを表します。

Expand

表7.343 値の概要
名前	Summary
`in_preview`	スナップショットをプレビューしています。
`locked`	スナップショットはロックされています。
`ok`	スナップショットに問題はありません。

7.263.1. locked
リンクのコピー

スナップショットはロックされています。

スナップショットは、作成、削除、復元、またはプレビュー中にロックされます。

7.264. SnapshotType enum
リンクのコピー

スナップショットのタイプを表します。

Expand

表7.344 値の概要
名前	Summary
`active`	仮想マシンの現在の設定への参照。
`preview`	プレビュー中のスナップショットがある場合、`active` スナップショットは `preview` になります。
`regular`	ユーザーが作成したスナップショット。
`stateless`	ステートレス仮想マシン用に内部で作成されたスナップショット。

7.264.1. preview
リンクのコピー

プレビュー中のスナップショットがある場合、active スナップショットは preview になります。

つまり、これは、プレビュー前の active スナップショットです。

7.264.2. stateless
リンクのコピー

ステートレス仮想マシン用に内部で作成されたスナップショット。

このスナップショットは、仮想マシンの起動時に作成され、仮想マシンのシャットダウン時に復元されます。

7.265. SpecialObjects 構造体
リンクのコピー

このタイプには、空白のテンプレートやタグ階層のルートなど、特別なオブジェクトへの参照が含まれます。

Expand

表7.345 リンクの概要
名前	型	Summary
`blank_template`	テンプレート	空白のテンプレートへの参照。
`root_tag`	タグ	タグ階層のルートへの参照。

7.266. Spm 構造体
リンクのコピー

Expand

表7.346 属性の概要
名前	型	Summary
`priority`	Integer
`status`	SpmStatus

7.267. SpmStatus enum
リンクのコピー

Expand

表7.347 値の概要
名前	Summary
`contending`
`none`
`spm`

7.268. Ssh 構造体
リンクのコピー

Expand

表7.348 属性の概要
名前	型	Summary
`authentication_method`	SshAuthenticationMethod
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`フィンガープリント (fingerprint)`	String	ホストの SSH 公開鍵のフィンガープリント。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`port`	Integer
`public_key`	String	link:https://tools で定義されている SSH 公開鍵フォーマットを使用したホストの SSH 公開鍵。
`user`	User

7.268.1. フィンガープリント (fingerprint)
リンクのコピー

ホストの SSH 公開鍵のフィンガープリント。このフィールドは 4.4.5 以降で非推奨となり、今後削除される予定です。

代わりに publicKey を使用してください。

7.268.2. public_key
リンクのコピー

RFC4253 で定義されている SSH 公開鍵フォーマットを使用した、ホストの SSH 公開鍵。

7.269. SshAuthenticationMethod enum
リンクのコピー

Expand

表7.349 値の概要
名前	Summary
`password`
`publickey`

7.270. SshPublicKey struct
リンクのコピー

Expand

表7.350 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`content`	String	保存された SSH キーが含まれています。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.351 リンクの概要
名前	型	Summary
`user`	User

7.271. Sso 構造体
リンクのコピー

Expand

表7.352 属性の概要
名前	型	Summary
`メソッド`	Method[]

7.272. SsoMethod enum
リンクのコピー

Expand

表7.353 値の概要
名前	Summary
`guest_agent`

7.273. 統計 struct
リンクのコピー

すべての種類の統計に使用されるジェネリックタイプ。

統計には、さまざまなエンティティーの統計値が含まれています。次のオブジェクトには統計が含まれています:

ディスク
ホスト
HostNic
NumaNode
Nic
Vm
GlusterBrick
Step
GlusterVolume

XML 表現の例:

<statistics>
  <statistic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234/statistics/1234">
    <name>data.current.rx</name>
    <description>Receive data rate</description>
    <values type="DECIMAL">
      <value>
        <datum>0</datum>
      </value>
    </values>
    <type>GAUGE</type>
    <unit>BYTES_PER_SECOND</unit>
    <host_nic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234"/>
  </statistic>
  ...
</statistics>

<statistics>
  <statistic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234/statistics/1234">
    <name>data.current.rx</name>
    <description>Receive data rate</description>
    <values type="DECIMAL">
      <value>
        <datum>0</datum>
      </value>
    </values>
    <type>GAUGE</type>
    <unit>BYTES_PER_SECOND</unit>
    <host_nic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234"/>
  </statistic>
  ...
</statistics>

Copy to Clipboard

Toggle word wrap

注記

この統計サブコレクションは読み取り専用です。

Expand

表7.354 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`kind`	StatisticKind	統計測定値のタイプ。
`name`	String	人間が判読できるプレーンテキストでの名前。
`type`	ValueType	後続の統計値のデータタイプ。
`unit`	StatisticUnit	統計値を測定する単位または割合。
`values`	Value[]	`datum` を含むデータセット。

Expand

表7.355 リンクの概要
名前	型	Summary
`brick`	GlusterBrick
`disk`	ディスク	含まれる `disk` リソースとの関係。
`gluster_volume`	GlusterVolume
`host`	ホスト
`host_nic`	HostNic	ホスト NIC への参照。
`host_numa_node`	NumaNode
`nic`	Nic
`step`	Step
`vm`	Vm

7.274. StatisticKind enum
リンクのコピー

Expand

表7.356 値の概要
名前	Summary
`カウンター`
`ゲージ`

7.275. StatisticUnit enum
リンクのコピー

Expand

表7.357 値の概要
名前	Summary
`bits_per_second`
`bytes`
`bytes_per_second`
`count_per_second`
`none`
`percent`
`秒`

7.276. Step 構造体
リンクのコピー

job 実行の一部であるステップを表します。ステップは、より広いシーケンスの一部である特定の実行ユニットを記述および追跡するために使用されます。一部のステップでは、進行状況の報告がサポートされています。

Expand

表7.358 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`end_time`	日付	ステップの終了時刻。
`external`	ブール値	ステップが外部システムによって開始されたかどうかを示します。
`external_type`	ExternalSystemType	ステップが参照する外部システム。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`number`	Integer	現在の階層レベルでのステップの順序。
`progress`	Integer	ステップの進行状況 (報告されている場合) のパーセンテージ。
`start_time`	日付	ステップの開始時間。
`status`	StepStatus	ステップのステータス。
`type`	StepEnum	ステップのタイプ。

7.276.1. external
リンクのコピー

ステップが外部システムによって開始されたかどうかを示します。外部ステップは、ステップの作成者によって外部で管理されます。

Expand

表7.359 リンクの概要
名前	型	Summary
`execution_host`	ホスト	ステップの実行に使用されるホスト (オプション)。
`job`	ジョブ	現在のステップ階層の最上位にある `job` を参照します。
`parent_step`	Step	階層内の現在のステップの親ステップを参照します。
`statistics`	Statistic[]

7.277. StepEnum enum
リンクのコピー

ステップタイプを表すタイプ。

Expand

表7.360 値の概要
名前	Summary
`executing`	実行中のステップタイプ。
`finalizing`	最終処理中のステップタイプ。
`rebalancing_volume`	`rebalancing volume` ステップタイプ。
`removing_bricks`	`removing bricks` ステップタイプ。
`unknown`	不明なステップタイプ。
`validating`	検証ステップタイプ。

7.277.1. executing
リンクのコピー

実行中のステップタイプ。ジョブのメイン実行ブロックを追跡するために使用されます。通常、これは実行ステップの一部を説明するいくつかのサブステップの親ステップになります。

7.277.2. finalizing
リンクのコピー

最終処理中のステップタイプ。job を完了するために必要な実行後のステップを説明します。

7.277.3. rebalancing_volume
リンクのコピー

rebalancing volume ステップタイプ。Gluster フローの一部であるステップタイプを説明します。

7.277.4. removing_bricks
リンクのコピー

removing bricks ステップタイプ。Gluster フローの一部であるステップタイプを説明します。

7.277.5. unknown
リンクのコピー

不明なステップタイプ。起源が不明なステップタイプを説明します。

7.277.6. validating
リンクのコピー

検証ステップタイプ。実行前に、パラメーターの正常性とパラメーターの有効性を検証するために使用されます。

7.278. StepStatus enum
リンクのコピー

ステップのステータスを表します。

Expand

表7.361 値の概要
名前	Summary
`aborted`	中止されたステップのステータス。
`failed`	失敗したステップのステータス。
`finished`	終了したステップのステータス。
`started`	開始されたステップのステータス。
`unknown`	不明なステップステータス。

7.278.1. aborted
リンクのコピー

中止されたステップのステータス。このステータスは、強制的に中止された外部ステップに適用されます。

7.278.2. finished
リンクのコピー

終了したステップのステータス。このステータスは、完了したステップの実行を示しています。

7.278.3. started
リンクのコピー

開始されたステップのステータス。このステータスは、現在実行中のステップを表します。

7.278.4. unknown
リンクのコピー

不明なステップステータス。このステータスは、解決方法が不明なステップ、つまり、システムが予期せず再起動される前に実行されたステップを表します。

7.279. StorageConnection 構造体
リンクのコピー

ストレージサーバー接続を表します。

XML 表現の例:

<storage_connection id="123">
  <address>mynfs.example.com</address>
  <type>nfs</type>
  <path>/exports/mydata</path>
</storage_connection>

<storage_connection id="123">
  <address>mynfs.example.com</address>
  <type>nfs</type>
  <path>/exports/mydata</path>
</storage_connection>

Copy to Clipboard

Toggle word wrap

Expand

表7.362 属性の概要
名前	型	Summary
`address`	String	ストレージサーバー接続のアドレス。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`mount_options`	String	NFS ストレージサーバー接続のマウントオプション。
`name`	String	人間が判読できるプレーンテキストでの名前。
`nfs_retrans`	Integer	NFS ストレージサーバー接続の NFS retrans 値。
`nfs_timeo`	Integer	NFS ストレージサーバー接続の NFS timeo 値。
`nfs_version`	NfsVersion	NFS ストレージサーバー接続の NFS バージョン。
`password`	String	iSCSI ストレージサーバー接続のパスワード。
`path`	String	NFS ストレージサーバー接続のパス。
`port`	Integer	iSCSI ストレージサーバー接続のポート。
`portal`	String	iSCSI ストレージサーバー接続のポータル。
`target`	String	iSCSI ストレージサーバー接続のターゲット。
`type`	StorageType	ストレージサーバー接続のタイプ。
`username`	String	iSCSI ストレージサーバー接続のユーザー名。
`vfs_type`	String	NFS ストレージサーバー接続の VFS タイプ。

Expand

表7.363 リンクの概要
名前	型	Summary
`gluster_volume`	GlusterVolume	そのストレージドメインで使用される gluster ボリュームへのリンク。
`host`	ホスト

7.280. StorageConnectionExtension 構造体
リンクのコピー

Expand

表7.364 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`password`	String
`target`	String
`username`	String

Expand

表7.365 リンクの概要
名前	型	Summary
`host`	ホスト

7.281. StorageDomain 構造体
リンクのコピー

ストレージドメイン。

識別子 123 を持つ NFS ストレージドメインの XML 表現です。

<storage_domain href="/ovirt-engine/api/storagedomains/123" id="123">
  <name>mydata</name>
  <description>My data</description>
  <available>38654705664</available>
  <committed>1073741824</committed>
  <critical_space_action_blocker>5</critical_space_action_blocker>
  <external_status>ok</external_status>
  <master>true</master>
  <storage>
    <address>mynfs.example.com</address>
    <nfs_version>v3</nfs_version>
    <path>/exports/mydata</path>
    <type>nfs</type>
  </storage>
  <storage_format>v3</storage_format>
  <type>data</type>
  <used>13958643712</used>
  <warning_low_space_indicator>10</warning_low_space_indicator>
  <wipe_after_delete>false</wipe_after_delete>
  <data_centers>
    <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
  </data_centers>
</storage_domain>

<storage_domain href="/ovirt-engine/api/storagedomains/123" id="123">
  <name>mydata</name>
  <description>My data</description>
  <available>38654705664</available>
  <committed>1073741824</committed>
  <critical_space_action_blocker>5</critical_space_action_blocker>
  <external_status>ok</external_status>
  <master>true</master>
  <storage>
    <address>mynfs.example.com</address>
    <nfs_version>v3</nfs_version>
    <path>/exports/mydata</path>
    <type>nfs</type>
  </storage>
  <storage_format>v3</storage_format>
  <type>data</type>
  <used>13958643712</used>
  <warning_low_space_indicator>10</warning_low_space_indicator>
  <wipe_after_delete>false</wipe_after_delete>
  <data_centers>
    <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
  </data_centers>
</storage_domain>

Copy to Clipboard

Toggle word wrap

Expand

表7.366 属性の概要
名前	型	Summary
`available`	Integer
`backup`	ブール値	この属性は、データストレージドメインがバックアップドメインとして使用されているかどうかを示します。
`block_size`	Integer	ストレージドメインのブロックサイズをバイト単位で指定します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`committed`	Integer
`critical_space_action_blocker`	Integer
`description`	String	プレーンテキストでの人間が判読できる説明。
`discard_after_delete`	ブール値	ブロック storage domain 上の disk のブロックが削除される直前に破棄されるかどうかを示します。
`external_status`	ExternalStatus
`id`	String	一意の ID
`import`	ブール値
`master`	ブール値
`name`	String	人間が判読できるプレーンテキストでの名前。
`status`	StorageDomainStatus
`storage`	HostStorage
`storage_format`	StorageFormat
`supports_discard`	ブール値	ブロックストレージドメインが破棄操作をサポートしているかどうかを示します。
`supports_discard_zeroes_data`	ブール値	ブロックストレージドメインがデータを破棄するプロパティーをサポートしているかどうかを示します。
`type`	StorageDomainType
`used`	Integer
`warning_low_space_indicator`	Integer
`wipe_after_delete`	ブール値	このストレージドメイン上のディスクの `wipe_after_delete` のデフォルト値として機能します。

7.281.1. backup
リンクのコピー

この属性は、データストレージドメインがバックアップドメインとして使用されているかどうかを示します。ドメインがバックアップに設定されている場合、エクスポートストレージドメインを使用するのと同じ方法で、障害復旧の目的で仮想マシンとテンプレートを保存するために使用されます。この属性は、データストレージドメインでのみ使用でき、ISO ドメインまたはエクスポートストレージドメインでは使用できません。ユーザーは、データストレージドメインの作成中またはデータストレージドメインのインポート中に、この機能を使用できます。

7.281.2. block_size
リンクのコピー

ストレージドメインのブロックサイズをバイト単位で指定します。省略可能で、その場合はデフォルトで 512 バイトになります。すべてのストレージドメインが、使用可能なすべてのサイズをサポートしているわけではありません。

7.281.3. discard_after_delete
リンクのコピー

ブロック storage domain 上の disk のブロックが削除される直前に破棄されるかどうかを示します。

true に設定され、このストレージドメインのディスクで wipe_after_delete 値が有効になっている場合、ディスクが削除されると次のようになります。

まず消去されます。
その後、そのブロックは破棄されます。
最後に削除されます。

以下の点に留意してください。

削除後の破棄は、非ブロックストレージタイプでは常に false になります。
削除後に破棄を true に設定できるのは、ストレージドメインが破棄をサポートしている場合のみです。

7.281.4. supports_discard
リンクのコピー

ブロックストレージドメインが破棄操作をサポートしているかどうかを示します。ストレージドメインは、構築元のすべての論理ユニットが破棄をサポートしている場合、つまり各論理ユニットの discard_max_size 値が 0 より大きい場合にのみ破棄をサポートします。これは、このストレージドメイン内の仮想ディスクの pass_discard 属性を有効にするために必要な条件の 1 つです。

7.281.5. supports_discard_zeroes_data
リンクのコピー

ブロックストレージドメインがデータを破棄するプロパティーをサポートしているかどうかを示します。ストレージドメインは、構築元のすべての論理ユニットがサポートする場合、つまり各論理ユニットの discard_zeroes_data 値が true の場合にのみ、データを破棄してゼロにするプロパティーをサポートします。

重要

7.281.6. wipe_after_delete
リンクのコピー

このストレージドメイン上のディスクの wipe_after_delete のデフォルト値として機能します。

つまり、新しく作成されたディスクは、デフォルトでストレージドメインから wipe_after_delete 値を取得します。なお、設定値 SANWipeAfterDelete は、ブロックストレージドメインの wipe_after_delete のデフォルト値として機能します。

Expand

表7.367 リンクの概要
名前	型	Summary
`data_center`	DataCenter	ストレージドメインがアタッチされているデータセンターへのリンク。
`data_centers`	DataCenter[]	ストレージドメインがアタッチされているデータセンターへの一連のリンク。
`disk_profiles`	DiskProfile[]
`disk_snapshots`	DiskSnapshot[]
`disks`	Disk[]
`files`	File[]
`host`	ホスト	ホストは作成時にのみ関連します。
`images`	Image[]
`permissions`	Permission[]
`storage_connections`	StorageConnection[]
`templates`	Template[]
`vms`	Vm[]

7.281.7. data_center
リンクのコピー

ストレージドメインがアタッチされているデータセンターへのリンク。ストレージドメインは複数のデータセンターにアタッチされる可能性があるため (ISO ドメインの場合)、これは後方互換性のためにのみ保持されます。代わりに dataCenters 要素を使用します。

7.282. StorageDomainLease 構造体
リンクのコピー

ストレージドメインに存在するリースを表します。

リースは、ストレージドメインの特別なボリュームに存在する Sanlock リソースです。この Sanlock リソースは、ストレージベースのロックを提供するために使用されます。

Expand

表7.368 リンクの概要
名前	型	Summary
`storage_domain`	StorageDomain	ロックが存在するストレージドメインへの参照。

7.283. StorageDomainStatus enum
リンクのコピー

Expand

表7.369 値の概要
名前	Summary
`activating`
`active`
`detaching`
`inactive`
`locked`
`maintenance`
`mixed`
`preparing_for_maintenance`
`unattached`
`unknown`

7.284. StorageDomainType enum
リンクのコピー

ストレージドメインが管理するデータの種類を示します。

Expand

表7.370 値の概要
名前	Summary
`data`	データドメインは、システム内の仮想マシンとテンプレートのディスクとスナップショットを格納するために使用されます。
`export`	エクスポートドメインは、データセンターと Red Hat Virtualization 環境の間で、仮想マシンとテンプレートをコピーおよび移動するために使用される一時的なストレージリポジトリーです。
`image`	外部システムからインポートできるイメージドメインストアイメージ。
`iso`	ISO ドメインは、仮想マシンのオペレーティングシステムとアプリケーションのインストールと起動に使用される ISO ファイル (または論理 CD) を格納します。
`managed_block_storage`	マネージドブロックストレージドメインは、ブロックストレージデバイス上に作成されます。
`volume`	ボリュームドメインは、仮想マシンのディスクとして使用できる論理ボリュームを格納します。

7.284.1. data
リンクのコピー

データドメインは、システム内の仮想マシンとテンプレートのディスクとスナップショットを格納するために使用されます。さらに、ディスクのスナップショットもデータドメインに保存されます。データドメインは、データセンター間で共有することはできません。

7.284.2. export
リンクのコピー

エクスポートドメインは、データセンターと Red Hat Virtualization 環境の間で、仮想マシンとテンプレートをコピーおよび移動するために使用される一時的なストレージリポジトリーです。エクスポートドメインは、仮想マシンのバックアップにも使用できます。エクスポートドメインは、データセンター間で移動することができますが、同時に 1 つのデータセンターでしか有効にすることができません。

7.284.3. image
リンクのコピー

外部システムからインポートできるイメージドメインストアイメージ。たとえば、OpenStack Glance イメージリポジトリーからのイメージ。

7.284.4. iso
リンクのコピー

ISO ドメインは、仮想マシンのオペレーティングシステムとアプリケーションのインストールと起動に使用される ISO ファイル (または論理 CD) を格納します。ISO ドメインにより、データセンターの物理メディアの必要性がなくなります。ISO ドメインは、異なるデータセンターで共有することができます。

7.284.5. managed_block_storage
リンクのコピー

マネージドブロックストレージドメインは、ブロックストレージデバイス上に作成されます。これらのドメインは、cinder によってアクセスおよび管理されます。

7.284.6. volume
リンクのコピー

ボリュームドメインは、仮想マシンのディスクとして使用できる論理ボリュームを格納します。たとえば、OpenStack Cincer ブロックストレージサービスのボリュームです。

7.285. StorageFormat enum
リンクのコピー

ストレージドメインのフォーマットを表すタイプ。

Expand

表7.371 値の概要
名前	Summary
`v1`	ストレージドメインフォーマットのバージョン 1 は、NFS、iSCSI、および FC ストレージドメインに適用できます。
`v2`	ストレージドメインフォーマットのバージョン 2 は、iSCSI および FC ストレージドメインに適用できます。
`v3`	ストレージドメインフォーマットのバージョン 3 は、NFS、POSIX、iSCSI、および FC ストレージドメインに適用できます。
`v4`	ストレージドメインフォーマットのバージョン 4。
`v5`	ストレージドメインフォーマットのバージョン 5 は、NFS、POSIX、および Gluster ストレージドメインに適用できます。

7.285.1. v1
リンクのコピー

ストレージドメインフォーマットのバージョン 1 は、NFS、iSCSI、および FC ストレージドメインに適用できます。

各ストレージドメインには、独自の構造を説明するメタデータと、仮想マシンのバックアップに使用されるすべての物理ボリュームの名前が含まれています。マスタードメインには、ストレージプール内のすべてのドメインと物理ボリューム名のメタデータが追加で含まれています。このメタデータの合計サイズは 2 KiB に制限されており、プールに含めることができるストレージドメインの数が制限されます。テンプレートと仮想マシンのベースイメージは読み取り専用です。

7.285.2. v2
リンクのコピー

ストレージドメインフォーマットのバージョン 2 は、iSCSI および FC ストレージドメインに適用できます。

すべてのストレージドメインとプールのメタデータは、論理ボリュームに書き込まれるのではなく、論理ボリュームタグとして保存されます。仮想マシンボリュームに関するメタデータは、引き続きドメインの論理ボリュームに保存されます。物理ボリューム名はメタデータに含まれなくなりました。テンプレートと仮想マシンのベースイメージは読み取り専用です。

7.285.3. v3
リンクのコピー

ストレージドメインフォーマットのバージョン 3 は、NFS、POSIX、iSCSI、および FC ストレージドメインに適用できます。

すべてのストレージドメインとプールのメタデータは、論理ボリュームに書き込まれるのではなく、論理ボリュームタグとして保存されます。仮想マシンボリュームに関するメタデータは、引き続きドメインの論理ボリュームに保存されます。仮想マシンとテンプレートのベースイメージは読み取り専用ではなくなりました。この変更により、ライブスナップショット、ライブストレージの移行、およびスナップショットからのクローン作成が可能になります。英語以外のボリューム名に対して、Unicode メタデータのサポートが追加されました。

7.285.4. v5
リンクのコピー

ストレージドメインフォーマットのバージョン 5 は、NFS、POSIX、および Gluster ストレージドメインに適用できます。

4096 バイトのブロックサイズと可変 sanlock アライメントのサポートが追加されました。

7.286. StorageType enum
リンクのコピー

ストレージドメインのタイプを表すタイプ。

Expand

表7.372 値の概要
名前	Summary
`cinder`	Cinder ストレージドメイン。
`fcp`	Fibre-Channel ストレージドメイン。
`glance`	Glance ストレージドメイン。
`glusterfs`	Gluster-FS ストレージドメイン。
`iscsi`	iSCSI ストレージドメイン。
`localfs`	ローカルストレージ上のストレージドメイン。
`managed_block_storage`	マネージドブロックストレージドメイン。
`nfs`	NFS ストレージドメイン。
`posixfs`	POSIX-FS ストレージドメイン。

7.286.1. cinder
リンクのコピー

Cinder ストレージドメイン。Cinder の詳細は、Cinder を参照してください。

7.286.2. glance
リンクのコピー

Glance ストレージドメイン。Glance の詳細は、Glance を参照してください。

7.286.3. glusterfs
リンクのコピー

Gluster-FS ストレージドメイン。Gluster の詳細は、Gluster を参照してください。

7.286.4. managed_block_storage
リンクのコピー

マネージドブロックストレージドメイン。cinderlib を使用して管理されるストレージドメイン。サポート対象のストレージドライバーについては、Available Drivers を参照してください。

7.287. SwitchType enum
リンクのコピー

Manager がサポートするすべてのスイッチタイプを説明します。

Expand

表7.373 値の概要
名前	Summary
`legacy`	ネイティブスイッチタイプ。
`ovs`	Open vSwitch タイプ。

7.288. SystemOption struct
リンクのコピー

システムの設定オプションを表すタイプ。

Expand

表7.374 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`values`	SystemOptionValue[]	さまざまなシステムバージョンのオプションの値。

7.289. SystemOptionValue struct
リンクのコピー

設定オプションの値とバージョンのペアを表すタイプ。

Expand

表7.375 属性の概要
名前	型	Summary
`value`	String	特定のバージョンの設定オプションの値。
`version`	String	設定オプションのバージョン。

7.290. Tag 構造体
リンクのコピー

システム内のタグを表します。

Expand

表7.376 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.377 リンクの概要
名前	型	Summary
`group`	グループ	このタグが割り当てられているグループへの参照。
`host`	ホスト	このタグが割り当てられているホストへの参照。
`parent`	タグ	このタグの親タグへの参照。
`template`	テンプレート	このタグが割り当てられたテンプレートへの参照。
`user`	User	このタグが割り当てられているユーザーへの参照。
`vm`	Vm	このタグが割り当てられている仮想マシンへの参照。

7.291. Template 構造体
リンクのコピー

仮想マシンテンプレートを表すタイプ。テンプレートを使用すると、共通の設定とディスク状態で仮想マシンを迅速にインスタンス化できます。

Expand

表7.378 属性の概要
名前	型	Summary
`auto_pinning_policy`	AutoPinningPolicy	自動 CPU および NUMA 設定を適用するかどうか、およびその適用方法を指定します。
`bios`	Bios	仮想マシンの BIOS 設定への参照。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`console`	Console	この仮想マシン用に設定されたコンソール。
`cpu`	Cpu	仮想マシン CPU の設定。
`cpu_pinning_policy`	CpuPinningPolicy	CPU および NUMA 設定を適用するかどうか、またどのように適用するかを指定します。
`cpu_shares`	Integer
`creation_time`	日付	仮想マシンの作成日。
`custom_compatibility_version`	バージョン	仮想マシンのカスタム互換性バージョン。
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	さまざまなフックを設定するために VDSM に送信されるプロパティー。
`delete_protected`	ブール値	`true` の場合、仮想マシンは削除できません。
`description`	String	プレーンテキストでの人間が判読できる説明。
`display`	表示	仮想マシンの表示設定。
`domain`	ドメイン	この仮想マシン用に設定されたドメイン。
`high_availability`	高可用性	仮想マシンの高可用性設定。
`id`	String	一意の ID
`initialization`	初期化	仮想マシンの初期化設定への参照。
`io`	Io	IO スレッドのパフォーマンスチューニング用。
`large_icon`	アイコン	仮想マシンの大きなアイコン。
`lease`	StorageDomainLease	この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。
`memory`	Integer	仮想マシンのメモリー (バイト単位)。
`memory_policy`	MemoryPolicy	仮想マシンのメモリー管理設定への参照。
`migration`	MigrationOptions	実行中の仮想マシンの別のホストへの移行設定への参照。
`migration_downtime`	Integer	別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。
`multi_queues_enabled`	ブール値	`true` の場合、各仮想インターフェイスは、利用可能な仮想 CPU に応じて最適な数のキューを取得します。
`name`	String	人間が判読できるプレーンテキストでの名前。
`origin`	String	この仮想マシンのオリジン。
`os`	OperatingSystem	仮想マシンにインストールされているオペレーティングシステムのタイプ。
`placement_policy`	VmPlacementPolicy	仮想マシンの配置ポリシーの設定。
`rng_device`	RngDevice	この仮想マシンの乱数ジェネレーターデバイスの設定。
`serial_number`	SerialNumber	クラスター内の仮想マシンのシリアル番号。
`small_icon`	アイコン	仮想マシンの小さなアイコン。
`soundcard_enabled`	ブール値	`true` の場合、サウンドカードが仮想マシンに追加されます。
`sso`	Sso	この仮想マシンが設定されているシングルサインオン設定への参照。
`start_paused`	ブール値	`true` の場合、仮想マシンは起動後、最初は 'paused' 状態になります。
`stateless`	ブール値	`true` の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。
`status`	TemplateStatus	テンプレートのステータス。
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	ストレージエラー後に仮想マシンを再開する方法を決定します。
`time_zone`	TimeZone	oVirt によって設定された仮想マシンのタイムゾーン。
`tpm_enabled`	ブール値	`true` の場合、TPM デバイスが仮想マシンに追加されます。
`tunnel_migration`	ブール値	`true` の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。
`type`	VmType	仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。
`usb`	Usb	この仮想マシンの USB デバイスの設定 (カウント、タイプ)。
`version`	TemplateVersion	これが別のテンプレートのベースバージョンであるかサブバージョンであるかを示します。
`virtio_scsi`	VirtioScsi	VirtIO SCSI 設定への参照。
`virtio_scsi_multi_queues`	Integer	このフィールドの Virtio-SCSI contoller のキュー数には virtioScsiMultiQueuesEnabled が true である必要があります。詳細は virtioScsiMultiQueuesEnabled を参照してください。
`virtio_scsi_multi_queues_enabled`	ブール値	`true` の場合、Virtio-SCSI デバイスは、使用可能な仮想 CPU とディスク、または指定された virtioScsiMultiQueues に応じて、いくつかの複数キューを取得します。
`vm`	Vm	このテンプレートに関連付けられている仮想マシンの設定。

7.291.1. auto_pinning_policy
リンクのコピー

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

重要

7.291.2. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

Copy to Clipboard

Toggle word wrap

7.291.3. cpu_pinning_policy
リンクのコピー

7.291.4. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

7.291.5. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

7.291.6. initialization
リンクのコピー

仮想マシンの初期化設定への参照。

注記

Red Hat Virtualization 4.1.8 以降、このプロパティーは空のタグを送信することでクリアできます。

たとえば、initialization 属性をクリアするには、次のようなリクエストを送ります。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <initialization/>
</vm>

<vm>
  <initialization/>
</vm>

Copy to Clipboard

Toggle word wrap

このようなリクエストへのレスポンス、およびヘッダー All-Content: true を持つリクエストには、引き続きこの属性が含まれます。

7.291.7. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.291.8. lease
リンクのコピー

この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。

7.291.9. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>

<vm>
  <memory>1073741824</memory>
</vm>

Copy to Clipboard

Toggle word wrap

注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 2³⁰ バイト = 1073741824 バイト。

注記

Red Hat Virtualization Manager は内部的に値を切り捨てて整数の MiB (1MiB = 2²⁰ バイト) にします。

7.291.10. migration
リンクのコピー

実行中の仮想マシンの別のホストへの移行設定への参照。

注記

7.291.11. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

7.291.12. origin
リンクのコピー

この仮想マシンのオリジン。

値:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.291.13. placement_policy
リンクのコピー

仮想マシンの配置ポリシーの設定。

この設定を更新して、仮想マシンを 1 つ以上のホストにピニングできます。

注記

たとえば、仮想マシンを 2 つのホストに固定するには、以下のリクエストを送信します。

PUT /api/vms/123

PUT /api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

Copy to Clipboard

Toggle word wrap

7.291.14. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.291.15. sso
リンクのコピー

7.291.16. tpm_enabled
リンクのコピー

Expand

表7.379 リンクの概要
名前	型	Summary
`cdroms`	Cdrom[]	テンプレートに接続された CD-ROM デバイスへの参照。
`cluster`	クラスター	仮想マシンが属するクラスターへの参照。
`cpu_profile`	CpuProfile	この仮想マシンによって使用される CPU プロファイルへの参照。
`disk_attachments`	DiskAttachment[]	テンプレートに割り当てられたディスクへの参照。
`graphics_consoles`	GraphicsConsole[]	テンプレートに接続されたグラフィックコンソールへの参照。
`mediated_devices`	VmMediatedDevice[]	仲介デバイスの設定。
`nics`	Nic[]	テンプレートにアタッチされたネットワークインターフェイスへの参照。
`permissions`	Permission[]	テンプレートに割り当てられたユーザーパーミッションへの参照。
`quota`	クォータ	この仮想マシンに設定されたクォータ設定への参照。
`storage_domain`	StorageDomain	仮想マシンが属するストレージドメインへの参照。
`tags`	Tag[]	テンプレートにアタッチされたタグへの参照。
`watchdogs`	Watchdog[]	テンプレートにアタッチされたウォッチドッグデバイスへの参照。

7.292. TemplateStatus enum
リンクのコピー

仮想マシンテンプレートのステータスを表すタイプ。

Expand

表7.380 値の概要
名前	Summary
`illegal`	このステータスは、テンプレートの少なくとも 1 つのディスクが不正であることを示します。
`locked`	このステータスは、テンプレートでの他の操作を妨げる何らかの操作が実行されていることを示します。
`ok`	このステータスは、テンプレートが有効で使用できる状態であることを示します。

7.293. TemplateVersion 構造体
リンクのコピー

仮想マシンテンプレートのバージョンを表すタイプ。

Expand

表7.381 属性の概要
名前	型	Summary
`version_name`	String	このバージョンの名前。
`version_number`	Integer	テンプレートのバージョン階層におけるこのバージョンのインデックス。

7.293.1. version_number
リンクのコピー

テンプレートのバージョン階層におけるこのバージョンのインデックス。インデックス 1 は、ベースバージョンとも呼ばれるテンプレートの元のバージョンを表します。

Expand

表7.382 リンクの概要
名前	型	Summary
`base_template`	テンプレート	このバージョンが関連付けられているテンプレートを参照します。

7.294. Ticket 構造体
リンクのコピー

仮想マシンへのアクセスを許可するチケットを表すタイプ。

Expand

表7.383 属性の概要
名前	型	Summary
`expiry`	Integer	チケットの有効期間 (秒単位)。
`value`	String	仮想マシンのアクセスチケット。

7.295. TimeZone 構造体
リンクのコピー

タイムゾーンの表現。

Expand

表7.384 属性の概要
名前	型	Summary
`name`	String	タイムゾーンの名前。
`utc_offset`	String	UTC オフセット。

7.295.1. utc_offset
リンクのコピー

UTC オフセット。

UTC からのオフセット。

7.296. TpmSupport enum
リンクのコピー

Expand

表7.385 値の概要
名前	Summary
`required`	TPM はオペレーティングシステムで必要です
`supported`	TPM はサポートされていますが、オプションです
`unsupported`

7.297. TransparentHugePages 構造体
リンクのコピー

Transparent huge pages (THP) のサポートを表すタイプ。

Expand

表7.386 属性の概要
名前	型	Summary
`enabled`	ブール値	THP サポートを有効にします。

7.298. TransportType enum
リンクのコピー

Gluster ボリュームへのアクセスに使用されるプロトコル。

Expand

表7.387 値の概要
名前	Summary
`rdma`	Remote direct memory access。
`tcp`	TCP。

7.299. UnmanagedNetwork 構造体
リンクのコピー

Expand

表7.388 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.389 リンクの概要
名前	型	Summary
`host`	ホスト
`host_nic`	HostNic

7.300. USB 構造体
リンクのコピー

仮想マシンの USB デバイスの設定。

Expand

表7.390 属性の概要
名前	型	Summary
`enabled`	ブール値	USB デバイスを含めるかどうかを決定します。
`type`	UsbType	USB タイプ、現在は `native` のみがサポートされます。

7.301. UsbType enum
リンクのコピー

USB デバイスリダイレクトのタイプ。

Expand

表7.391 値の概要
名前	Summary
`legacy`	レガシー USB リダイレクト。
`native`	ネイティブ USB リダイレクト。

7.301.1. legacy
リンクのコピー

レガシー USB リダイレクト。

この USB タイプは、エンジンのバージョン 3.6 から非推奨となり、バージョン 4.1 で完全に削除されました。これは、既存のスクリプトの構文エラーを回避するためだけに保持されています。使用した場合は、自動的に native に置き換わります。

7.301.2. native
リンクのコピー

ネイティブ USB リダイレクト。

ネイティブ USB リダイレクトでは、Linux および Windows 仮想マシンの KVM/SPICE USB リダイレクトが許可されます。仮想 (ゲスト) マシンには、ネイティブ USB 用のゲストがインストールされたエージェントやドライバーは必要ありません。Linux クライアントでは、USB リダイレクトに必要なすべてのパッケージは virt-viewer パッケージで提供されます。Windows クライアントで usbdk パッケージもインストールする必要があります。

7.302. User 構造体
リンクのコピー

システム内のユーザーを表します。

Expand

表7.392 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`department`	String
`description`	String	プレーンテキストでの人間が判読できる説明。
`domain_entry_id`	String
`email`	String
`id`	String	一意の ID
`last_name`	String
`logged_in`	ブール値
`name`	String	人間が判読できるプレーンテキストでの名前。
`namespace`	String	ユーザーが存在する名前空間。
`password`	String
`principal`	String	`user_name` と同様です。
`user_name`	String	ユーザーのユーザー名。
`user_options`	Property[]	ユーザーオプションを使用すると、個々のユーザーごとに設定をカスタマイズするために使用されるキー/値のプロパティーを保存できます。

7.302.1. namespace
リンクのコピー

ユーザーが存在する名前空間。ユーザーを LDAP サーバーに格納する認可プロバイダーを使用する場合、この属性は LDAP サーバーのネーミングコンテキストと等しくなります。詳細は oVirt Engine Extension AAA LDAP を参照してください。ユーザーをデータベースに格納するビルトイン認可プロバイダーを使用する場合、この属性は無視されます。詳細は oVirt Engine extension - AAA - JDBC を参照してください。

7.302.2. principal
リンクのコピー

user_name と同様です。フォーマットは LDAP プロバイダーによって異なります。ほとんどの LDAP プロバイダーでは、uid LDAP 属性の値です。Active Directory の場合は、ユーザープリンシパル名 (UPN) です。

7.302.3. user_name
リンクのコピー

ユーザーのユーザー名。フォーマットは、認可プロバイダーのタイプによって異なります。ほとんどの LDAP プロバイダーでは、uid LDAP 属性の値です。Active Directory では、ユーザープリンシパル名 (UPN) です。UPN または uid の後には、認証プロバイダー名が続く必要があります。たとえば、LDAP の uid 属性の場合、myuser@myextension-authz です。UPN を使用する Active Directory の場合、myuser@mysubdomain.mydomain.com@myextension-authz です。この属性は、新しいユーザーを追加する際の必須パラメーターです。

7.302.4. user_options
リンクのコピー

ユーザーオプションを使用すると、個々のユーザーごとに設定をカスタマイズするために使用されるキー/値のプロパティーを保存できます。バージョン 4.4.5 以降、このプロパティーは非推奨となり、後方互換性のためにのみ保持されていることに注意してください。これは今後削除されます。代わりに options エンドポイントを使用してください。

Expand

表7.393 リンクの概要
名前	型	Summary
`domain`	ドメイン
`グループ`	Group[]
`options`	UserOption[]
`permissions`	Permission[]
`roles`	Role[]	ユーザーリソースのロールサブコレクションへのリンク。
`ssh_public_keys`	SshPublicKey[]
`tags`	Tag[]	ユーザーリソースのタグサブコレクションへのリンク。

7.303. UserOption 構造体
リンクのコピー

ユーザーオプションを使用すると、個々のユーザーごとに設定をカスタマイズするために使用されるキー/値のプロパティーを保存できます。

Expand

表7.394 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`content`	String	文字列としてエンコードされた JSON コンテンツ。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

7.303.1. content
リンクのコピー

文字列としてエンコードされた JSON コンテンツ。有効な JSON がサポートされています。

Expand

表7.395 リンクの概要
名前	型	Summary
`user`	User

7.304. Value 構造体
リンクのコピー

Expand

表7.396 属性の概要
名前	型	Summary
`datum`	10 進数
`detail`	String

7.305. ValueType enum
リンクのコピー

Expand

表7.397 値の概要
名前	Summary
`decimal`
`integer`
`string`

7.306. VcpuPin 構造体
リンクのコピー

Expand

表7.398 属性の概要
名前	型	Summary
`cpu_set`	String
`vcpu`	Integer

7.307. Vendor 構造体
リンクのコピー

Expand

表7.399 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

7.308. Version 構造体
リンクのコピー

Expand

表7.400 属性の概要
名前	型	Summary
`build`	Integer
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`full_version`	String
`id`	String	一意の ID
`major`	Integer
`minor`	Integer
`name`	String	人間が判読できるプレーンテキストでの名前。
`revision`	Integer

7.309. VgpuPlacement enum
リンクのコピー

vGPU 配置ストラテジー。

最初の使用可能な物理カードに vGPU を配置するか、複数の物理カードに分散することができます。

Expand

表7.401 値の概要
名前	Summary
`consolidated`	統合配置を使用します。
`separated`	分離配置を使用します。

7.309.1. consolidated
リンクのコピー

統合配置を使用します。各 vGPU は、空き容量のある最初の物理カードに配置されます。

これはデフォルトの配置であり、物理カードの利用可能なスペースをすべて利用します。

7.309.2. separated
リンクのコピー

分離配置を使用します。可能であれば、各 vGPU は個別の物理カードに配置されます。

これは、vGPU のパフォーマンスを向上させるのに役立ちます。

7.310. VirtioScsi struct
リンクのコピー

virtio-SCSI のサポートを表すタイプ。サポートされている場合は、SCSI ゲストデバイスに virtio ドライバーを使用します。

Expand

表7.402 属性の概要
名前	型	Summary
`enabled`	ブール値	Virtio SCSI サポートを有効にします。

7.311. VirtualNumaNode struct
リンクのコピー

仮想 NUMA ノードを表します。

XML 表現の例:

<vm_numa_node href="/ovirt-engine/api/vms/123/numanodes/456" id="456">
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>1024</memory>
  <numa_node_pins>
    <numa_node_pin>
      <index>0</index>
    </numa_node_pin>
  </numa_node_pins>
  <vm href="/ovirt-engine/api/vms/123" id="123" />
</vm_numa_node>

<vm_numa_node href="/ovirt-engine/api/vms/123/numanodes/456" id="456">
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>1024</memory>
  <numa_node_pins>
    <numa_node_pin>
      <index>0</index>
    </numa_node_pin>
  </numa_node_pins>
  <vm href="/ovirt-engine/api/vms/123" id="123" />
</vm_numa_node>

Copy to Clipboard

Toggle word wrap

Expand

表7.403 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`cpu`	Cpu
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`index`	Integer
`memory`	Integer	NUMA ノードのメモリー (MB)。
`name`	String	人間が判読できるプレーンテキストでの名前。
`node_distance`	String
`numa_node_pins`	NumaNodePin[]
`numa_tune_mode`	NumaTuneMode	NUMA トポロジーの適用方法。

Expand

表7.404 リンクの概要
名前	型	Summary
`host`	ホスト
`statistics`	Statistic[]	各ホスト NUMA ノードリソースは、ホスト NUMA ノード固有の統計の統計サブコレクションを公開します。
`vm`	Vm

7.311.1. statistics
リンクのコピー

各ホスト NUMA ノードリソースは、ホスト NUMA ノード固有の統計の統計サブコレクションを公開します。

XML 表現の例:

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" />
  </statistic>
    ...
</statistics>

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" />
  </statistic>
    ...
</statistics>

Copy to Clipboard

Toggle word wrap

注記

この統計サブコレクションは読み取り専用です。

次のリストは、ホスト NUMA ノードの統計タイプを示しています。

Expand

名前	説明
`memory.total`	NUMA ノードの合計メモリー (バイト単位)。
`memory.used`	NUMA ノードで使用されるメモリー (バイト単位)。
`memory.free`	NUMA ノードの空きメモリー (バイト単位)。
`cpu.current.user`	ユーザースライスの CPU 使用率。
`cpu.current.system`	システムの CPU 使用率。
`cpu.current.idle`	アイドル状態の CPU 使用率。

7.312. Vlan 構造体
リンクのコピー

仮想 LAN (VLAN) タイプを表すタイプ。

Expand

表7.405 属性の概要
名前	型	Summary
`id`	Integer	仮想 LAN ID。

7.313. Vm 構造体
リンクのコピー

仮想マシンを表します。

Expand

表7.406 属性の概要
名前	型	Summary
`auto_pinning_policy`	AutoPinningPolicy	自動 CPU および NUMA 設定を適用するかどうか、およびその適用方法を指定します。
`bios`	Bios	仮想マシンの BIOS 設定への参照。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`console`	Console	この仮想マシン用に設定されたコンソール。
`cpu`	Cpu	仮想マシン CPU の設定。
`cpu_pinning_policy`	CpuPinningPolicy	CPU および NUMA 設定を適用するかどうか、またどのように適用するかを指定します。
`cpu_shares`	Integer
`creation_time`	日付	仮想マシンの作成日。
`custom_compatibility_version`	バージョン	仮想マシンのカスタム互換性バージョン。
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	さまざまなフックを設定するために VDSM に送信されるプロパティー。
`delete_protected`	ブール値	`true` の場合、仮想マシンは削除できません。
`description`	String	プレーンテキストでの人間が判読できる説明。
`display`	表示	仮想マシンの表示設定。
`domain`	ドメイン	この仮想マシン用に設定されたドメイン。
`fqdn`	String	仮想マシンの完全修飾ドメイン名。
`guest_operating_system`	GuestOperatingSystem	仮想マシンにインストールされているオペレーティングシステム。
`guest_time_zone`	TimeZone	仮想マシンが使用するタイムゾーン (ゲストエージェントによって返されます)。
`has_illegal_images`	ブール値	仮想マシンに、ディスクが `ILLEGAL` 状態のスナップショットがあるかどうかを示します。
`high_availability`	高可用性	仮想マシンの高可用性設定。
`id`	String	一意の ID
`initialization`	初期化	仮想マシンの初期化設定への参照。
`io`	Io	IO スレッドのパフォーマンスチューニング用。
`large_icon`	アイコン	仮想マシンの大きなアイコン。
`lease`	StorageDomainLease	この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。
`memory`	Integer	仮想マシンのメモリー (バイト単位)。
`memory_policy`	MemoryPolicy	仮想マシンのメモリー管理設定への参照。
`migration`	MigrationOptions	実行中の仮想マシンの別のホストへの移行設定への参照。
`migration_downtime`	Integer	別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。
`multi_queues_enabled`	ブール値	`true` の場合、各仮想インターフェイスは、利用可能な仮想 CPU に応じて最適な数のキューを取得します。
`name`	String	人間が判読できるプレーンテキストでの名前。
`next_run_configuration_exists`	ブール値	仮想マシンの設定が変更されたため、仮想マシンの再起動が必要です。
`numa_tune_mode`	NumaTuneMode	NUMA トポロジーの適用方法。
`origin`	String	この仮想マシンのオリジン。
`os`	OperatingSystem	仮想マシンにインストールされているオペレーティングシステムのタイプ。
`payloads`	Payload[]	仮想マシンのオプションのペイロード。ISO が仮想マシンを設定するために使用されます。
`placement_policy`	VmPlacementPolicy	仮想マシンの配置ポリシーの設定。
`rng_device`	RngDevice	この仮想マシンの乱数ジェネレーターデバイスの設定。
`run_once`	ブール値	`true` の場合、仮想マシンは run once コマンドを使用して開始されています。つまり、この 1 回の実行のために保存されている設定とは異なる可能性があります。
`serial_number`	SerialNumber	クラスター内の仮想マシンのシリアル番号。
`small_icon`	アイコン	仮想マシンの小さなアイコン。
`soundcard_enabled`	ブール値	`true` の場合、サウンドカードが仮想マシンに追加されます。
`sso`	Sso	この仮想マシンが設定されているシングルサインオン設定への参照。
`start_paused`	ブール値	`true` の場合、仮想マシンは起動後、最初は 'paused' 状態になります。
`start_time`	日付	仮想マシンが起動された日付。
`stateless`	ブール値	`true` の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。
`status`	VmStatus	仮想マシンの現在の状態
`status_detail`	String	人間が読める現在のステータスの詳細。
`stop_reason`	String	仮想マシンが停止した理由。
`stop_time`	日付	仮想マシンが停止された日付。
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	ストレージエラー後に仮想マシンを再開する方法を決定します。
`time_zone`	TimeZone	oVirt によって設定された仮想マシンのタイムゾーン。
`tpm_enabled`	ブール値	`true` の場合、TPM デバイスが仮想マシンに追加されます。
`tunnel_migration`	ブール値	`true` の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。
`type`	VmType	仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。
`usb`	Usb	この仮想マシンの USB デバイスの設定 (カウント、タイプ)。
`use_latest_template_version`	ブール値	`true` の場合、仮想マシンは起動時にテンプレートの最新バージョンに再設定されます。
`virtio_scsi`	VirtioScsi	VirtIO SCSI 設定への参照。
`virtio_scsi_multi_queues`	Integer	このフィールドの Virtio-SCSI contoller のキュー数には virtioScsiMultiQueuesEnabled が true である必要があります。詳細は virtioScsiMultiQueuesEnabled を参照してください。
`virtio_scsi_multi_queues_enabled`	ブール値	`true` の場合、Virtio-SCSI デバイスは、使用可能な仮想 CPU とディスク、または指定された virtioScsiMultiQueues に応じて、いくつかの複数キューを取得します。

7.313.1. auto_pinning_policy
リンクのコピー

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

重要

7.313.2. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

Copy to Clipboard

Toggle word wrap

7.313.3. cpu_pinning_policy
リンクのコピー

7.313.4. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

7.313.5. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

7.313.6. initialization
リンクのコピー

仮想マシンの初期化設定への参照。

注記

Red Hat Virtualization 4.1.8 以降、このプロパティーは空のタグを送信することでクリアできます。

たとえば、initialization 属性をクリアするには、次のようなリクエストを送ります。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <initialization/>
</vm>

<vm>
  <initialization/>
</vm>

Copy to Clipboard

Toggle word wrap

このようなリクエストへのレスポンス、およびヘッダー All-Content: true を持つリクエストには、引き続きこの属性が含まれます。

7.313.7. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.313.8. lease
リンクのコピー

この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。

7.313.9. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>

<vm>
  <memory>1073741824</memory>
</vm>

Copy to Clipboard

Toggle word wrap

注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 2³⁰ バイト = 1073741824 バイト。

注記

Red Hat Virtualization Manager は内部的に値を切り捨てて整数の MiB (1MiB = 2²⁰ バイト) にします。

7.313.10. migration
リンクのコピー

実行中の仮想マシンの別のホストへの移行設定への参照。

注記

7.313.11. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

7.313.12. next_run_configuration_exists
リンクのコピー

仮想マシンの設定が変更されたため、仮想マシンの再起動が必要です。変更された設定は、仮想マシンの シャットダウン 処理時に適用されます。

7.313.13. numa_tune_mode
リンクのコピー

NUMA トポロジーの適用方法。非推奨となりました。vNUMA ノードごとの NUMA 調整が使用されます。

7.313.14. origin
リンクのコピー

この仮想マシンのオリジン。

値:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.313.15. placement_policy
リンクのコピー

仮想マシンの配置ポリシーの設定。

この設定を更新して、仮想マシンを 1 つ以上のホストにピニングできます。

注記

たとえば、仮想マシンを 2 つのホストに固定するには、以下のリクエストを送信します。

PUT /api/vms/123

PUT /api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

Copy to Clipboard

Toggle word wrap

7.313.16. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.313.17. sso
リンクのコピー

7.313.18. stop_reason
リンクのコピー

仮想マシンが停止した理由。オプションで、仮想マシンをシャットダウンするときにユーザーが設定します。

7.313.19. tpm_enabled
リンクのコピー

Expand

表7.407 リンクの概要
名前	型	Summary
`affinity_labels`	AffinityLabel[]	オプション
`applications`	Application[]	仮想マシンにインストールされているアプリケーションのリスト。
`cdroms`	Cdrom[]	CDROM にマウントされた ISO への参照。
`cluster`	クラスター	仮想マシンが属するクラスターへの参照。
`cpu_profile`	CpuProfile	この仮想マシンによって使用される CPU プロファイルへの参照。
`disk_attachments`	DiskAttachment[]	仮想マシンにアタッチされているディスクへの参照。
`dynamic_cpu`	DynamicCpu	仮想マシン CPU の動的設定。
`external_host_provider`	ExternalHostProvider
`floppies`	Floppy[]	フロッピーにマウントされた ISO への参照。
`graphics_consoles`	GraphicsConsole[]	この仮想マシン用に設定されたグラフィックコンソールのリスト。
`host`	ホスト	仮想マシンが実行されているホストへの参照。
`host_devices`	HostDevice[]	この仮想マシンに関連付けられているデバイスへの参照。
`instance_type`	InstanceType	仮想マシンの設定は、インスタンスタイプの 1 つを介してオプションで事前定義できます。
`katello_errata`	KatelloErratum[]	仮想マシンに割り当てられたすべての Katello エラータをリスト表示します。
`mediated_devices`	VmMediatedDevice[]	仲介デバイスの設定。
`nics`	Nic[]	仮想マシン上のネットワークインターフェイスデバイスのリストを参照します。
`numa_nodes`	NumaNode[]	この仮想マシンで使用される NUMA ノード設定を参照します。
`original_template`	テンプレート	仮想マシンの作成に使用された元のテンプレートを参照します。
`permissions`	Permission[]	この仮想マシンに設定されたパーミッション。
`quota`	クォータ	この仮想マシンに設定されたクォータ設定への参照。
`reported_devices`	ReportedDevice[]
`sessions`	Session[]	この仮想マシンに対して開かれているユーザーセッションのリスト。
`snapshots`	Snapshot[]	仮想マシンから取得されたすべてのスナップショットを参照します。
`statistics`	Statistic[]	この仮想マシンから収集された統計データ。
`storage_domain`	StorageDomain	仮想マシンが属するストレージドメインへの参照。
`tags`	Tag[]
`template`	テンプレート	仮想マシンがベースとするテンプレートへの参照。
`vm_pool`	VmPool	仮想マシンが任意のメンバーであるプールへの参照。
`watchdogs`	Watchdog[]	ウォッチドッグ設定への参照。

7.313.20. affinity_labels
リンクのコピー

オプションサブクラスターのラベル付けに使用されます。

7.313.21. katello_errata
リンクのコピー

仮想マシンに割り当てられたすべての Katello エラータをリスト表示します。

GET /ovirt-engine/api/vms/123/katelloerrata

GET /ovirt-engine/api/vms/123/katelloerrata

Copy to Clipboard

Toggle word wrap

以下のような XML で応答を受け取ります。

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

Copy to Clipboard

Toggle word wrap

7.313.22. original_template
リンクのコピー

仮想マシンの作成に使用された元のテンプレートを参照します。

それ以外の場合は、template と original_template は同じです。

7.313.23. statistics
リンクのコピー

この仮想マシンから収集された統計データ。

7.314. VmAffinity enum
リンクのコピー

Expand

表7.408 値の概要
名前	Summary
`migratable`
`pinned`
`user_migratable`

7.315. VmBase 構造体
リンクのコピー

基本的な仮想マシン設定を表します。これは、仮想マシン、テンプレート、およびインスタンスタイプで使用されます。

Expand

表7.409 属性の概要
名前	型	Summary
`auto_pinning_policy`	AutoPinningPolicy	自動 CPU および NUMA 設定を適用するかどうか、およびその適用方法を指定します。
`bios`	Bios	仮想マシンの BIOS 設定への参照。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`console`	Console	この仮想マシン用に設定されたコンソール。
`cpu`	Cpu	仮想マシン CPU の設定。
`cpu_pinning_policy`	CpuPinningPolicy	CPU および NUMA 設定を適用するかどうか、またどのように適用するかを指定します。
`cpu_shares`	Integer
`creation_time`	日付	仮想マシンの作成日。
`custom_compatibility_version`	バージョン	仮想マシンのカスタム互換性バージョン。
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	さまざまなフックを設定するために VDSM に送信されるプロパティー。
`delete_protected`	ブール値	`true` の場合、仮想マシンは削除できません。
`description`	String	プレーンテキストでの人間が判読できる説明。
`display`	表示	仮想マシンの表示設定。
`domain`	ドメイン	この仮想マシン用に設定されたドメイン。
`high_availability`	高可用性	仮想マシンの高可用性設定。
`id`	String	一意の ID
`initialization`	初期化	仮想マシンの初期化設定への参照。
`io`	Io	IO スレッドのパフォーマンスチューニング用。
`large_icon`	アイコン	仮想マシンの大きなアイコン。
`lease`	StorageDomainLease	この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。
`memory`	Integer	仮想マシンのメモリー (バイト単位)。
`memory_policy`	MemoryPolicy	仮想マシンのメモリー管理設定への参照。
`migration`	MigrationOptions	実行中の仮想マシンの別のホストへの移行設定への参照。
`migration_downtime`	Integer	別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。
`multi_queues_enabled`	ブール値	`true` の場合、各仮想インターフェイスは、利用可能な仮想 CPU に応じて最適な数のキューを取得します。
`name`	String	人間が判読できるプレーンテキストでの名前。
`origin`	String	この仮想マシンのオリジン。
`os`	OperatingSystem	仮想マシンにインストールされているオペレーティングシステムのタイプ。
`placement_policy`	VmPlacementPolicy	仮想マシンの配置ポリシーの設定。
`rng_device`	RngDevice	この仮想マシンの乱数ジェネレーターデバイスの設定。
`serial_number`	SerialNumber	クラスター内の仮想マシンのシリアル番号。
`small_icon`	アイコン	仮想マシンの小さなアイコン。
`soundcard_enabled`	ブール値	`true` の場合、サウンドカードが仮想マシンに追加されます。
`sso`	Sso	この仮想マシンが設定されているシングルサインオン設定への参照。
`start_paused`	ブール値	`true` の場合、仮想マシンは起動後、最初は 'paused' 状態になります。
`stateless`	ブール値	`true` の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	ストレージエラー後に仮想マシンを再開する方法を決定します。
`time_zone`	TimeZone	oVirt によって設定された仮想マシンのタイムゾーン。
`tpm_enabled`	ブール値	`true` の場合、TPM デバイスが仮想マシンに追加されます。
`tunnel_migration`	ブール値	`true` の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。
`type`	VmType	仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。
`usb`	Usb	この仮想マシンの USB デバイスの設定 (カウント、タイプ)。
`virtio_scsi`	VirtioScsi	VirtIO SCSI 設定への参照。
`virtio_scsi_multi_queues`	Integer	このフィールドの Virtio-SCSI contoller のキュー数には virtioScsiMultiQueuesEnabled が true である必要があります。詳細は virtioScsiMultiQueuesEnabled を参照してください。
`virtio_scsi_multi_queues_enabled`	ブール値	`true` の場合、Virtio-SCSI デバイスは、使用可能な仮想 CPU とディスク、または指定された virtioScsiMultiQueues に応じて、いくつかの複数キューを取得します。

7.315.1. auto_pinning_policy
リンクのコピー

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

重要

7.315.2. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

Copy to Clipboard

Toggle word wrap

7.315.3. cpu_pinning_policy
リンクのコピー

7.315.4. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

7.315.5. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

7.315.6. initialization
リンクのコピー

仮想マシンの初期化設定への参照。

注記

Red Hat Virtualization 4.1.8 以降、このプロパティーは空のタグを送信することでクリアできます。

たとえば、initialization 属性をクリアするには、次のようなリクエストを送ります。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <initialization/>
</vm>

<vm>
  <initialization/>
</vm>

Copy to Clipboard

Toggle word wrap

このようなリクエストへのレスポンス、およびヘッダー All-Content: true を持つリクエストには、引き続きこの属性が含まれます。

7.315.7. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.315.8. lease
リンクのコピー

この仮想マシン/テンプレートリースが存在するストレージドメインへの参照。

7.315.9. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>

<vm>
  <memory>1073741824</memory>
</vm>

Copy to Clipboard

Toggle word wrap

注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 2³⁰ バイト = 1073741824 バイト。

注記

Red Hat Virtualization Manager は内部的に値を切り捨てて整数の MiB (1MiB = 2²⁰ バイト) にします。

7.315.10. migration
リンクのコピー

実行中の仮想マシンの別のホストへの移行設定への参照。

注記

7.315.11. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

7.315.12. origin
リンクのコピー

この仮想マシンのオリジン。

値:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.315.13. placement_policy
リンクのコピー

仮想マシンの配置ポリシーの設定。

この設定を更新して、仮想マシンを 1 つ以上のホストにピニングできます。

注記

たとえば、仮想マシンを 2 つのホストに固定するには、以下のリクエストを送信します。

PUT /api/vms/123

PUT /api/vms/123

Copy to Clipboard

Toggle word wrap

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

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

Copy to Clipboard

Toggle word wrap

7.315.14. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

7.315.15. sso
リンクのコピー

7.315.16. tpm_enabled
リンクのコピー

Expand

表7.410 リンクの概要
名前	型	Summary
`cluster`	クラスター	仮想マシンが属するクラスターへの参照。
`cpu_profile`	CpuProfile	この仮想マシンによって使用される CPU プロファイルへの参照。
`quota`	クォータ	この仮想マシンに設定されたクォータ設定への参照。
`storage_domain`	StorageDomain	仮想マシンが属するストレージドメインへの参照。

7.316. VmDeviceType enum
リンクのコピー

Expand

表7.411 値の概要
名前	Summary
`cdrom`
`floppy`

7.317. VmMediatedDevice struct
リンクのコピー

仮想マシン仲介デバイスは、vGPU 仲介デバイスのプロパティーを指定するフェイクデバイスです。これは実際のデバイスではなく、ホストデバイスの一部を設定する方法の仕様として機能します。

Expand

表7.412 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。
`spec_params`	Property[]	デバイスのプロパティー。

Expand

表7.413 リンクの概要
名前	型	Summary
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.317.1. vms
リンクのコピー

7.318. VmPlacementPolicy 構造体
リンクのコピー

Expand

表7.414 属性の概要
名前	型	Summary
`affinity`	VmAffinity

Expand

表7.415 リンクの概要
名前	型	Summary
`hosts`	Host[]

7.319. VmPool 構造体
リンクのコピー

仮想マシンプールを表すタイプ。

Expand

表7.416 属性の概要
名前	型	Summary
`auto_storage_select`	ブール値	テンプレートがコピーされる複数のストレージドメイン間でプールが仮想マシンのディスクを自動的に分散するかどうかを示します。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`display`	表示	プール内の仮想マシンに対して設定された表示設定。
`id`	String	一意の ID
`max_user_vms`	Integer	特定のユーザーに割り当てることができるプール内の仮想マシンの最大数。
`name`	String	人間が判読できるプレーンテキストでの名前。
`prestarted_vms`	Integer	システムは、指定された数の仮想マシンをプールから事前起動しようとします。
`rng_device`	RngDevice	プール内の仮想マシン用に設定された乱数ジェネレーターデバイス。
`size`	Integer	プール内の仮想マシンの数。
`soundcard_enabled`	ブール値	プール内の仮想マシンに対してサウンドカードを設定する必要があるかどうかを示します。
`stateful`	ブール値	仮想マシンプールのステートフルフラグ。
`tpm_enabled`	ブール値	`true` の場合、TPM デバイスが仮想マシンに追加されます。
`type`	VmPoolType	プール内の仮想マシンの割り当て解除ポリシー。
`use_latest_template_version`	ブール値	プール内の仮想マシンが、プールのベースなっているテンプレートの新しいバージョンに更新されているかどうかを示します。

7.319.1. auto_storage_select
リンクのコピー

テンプレートがコピーされる複数のストレージドメイン間でプールが仮想マシンのディスクを自動的に分散するかどうかを示します。

プールで使用されるテンプレートが複数のストレージドメインに存在する場合、プールの仮想マシンのディスクはそれらのストレージドメインの 1 つに作成されます。デフォルトまたはこの属性の値が false の場合、そのストレージドメインはプール作成時に選択され、すべての仮想マシンが同じものを使用します。この属性が true の場合、仮想マシンがプールに追加されると、より多くの空き容量を持つストレージドメインが選択されます。

7.319.2. display
リンクのコピー

プール内の仮想マシンに対して設定された表示設定。

警告

この属性は機能しておらず、現在は非推奨となっていることに注意してください。代わりに Vm.display を使用してください。

7.319.3. prestarted_vms
リンクのコピー

システムは、指定された数の仮想マシンをプールから事前起動しようとします。

これらの仮想マシンは、どのユーザーにもアタッチされずに起動されます。こうすることで、ユーザーはプールからより速く仮想マシンを取得できます。

7.319.4. stateful
リンクのコピー

仮想マシンプールのステートフルフラグ。

ステートフル仮想マシンプールの仮想マシンは、常にステートフルモードで起動されます (ステートレススナップショットは作成されません)。仮想マシンが別のユーザーに渡された場合でも、仮想マシンの状態は保持されます。

7.319.5. tpm_enabled
リンクのコピー

Expand

表7.417 リンクの概要
名前	型	Summary
`cluster`	クラスター	プールが存在するクラスターへの参照。
`instance_type`	InstanceType	このプールのベースとなるインスタンスタイプへの参照。
`permissions`	Permission[]	この仮想マシンプールに設定されたパーミッション。
`template`	テンプレート	プールのベースとなるテンプレートへの参照。
`vm`	Vm	プールの一部である任意の仮想マシンへの参照。

7.319.6. instance_type
リンクのコピー

このプールのベースとなるインスタンスタイプへの参照。プールの作成時にのみ設定でき、編集はできません。

7.319.7. vm
リンクのコピー

プールの一部である任意の仮想マシンへの参照。

この仮想マシンは、プールのテンプレートの最新バージョンをベースにしていない可能性があることに注意してください。

7.320. VmPoolType enum
リンクのコピー

仮想マシンプール内の仮想マシンの割り当て解除ポリシーを表すタイプ。

Expand

表7.418 値の概要
名前	Summary
`automatic`	このポリシーは、プール内の仮想マシンがシステムによって自動的に割り当て解除されることを示します。
`manual`	このポリシーは、プール内の仮想マシンが管理者によって手動で割り当て解除されることを示します。

7.320.1. automatic
リンクのコピー

このポリシーは、プール内の仮想マシンがシステムによって自動的に割り当て解除されることを示します。

このポリシーでは、プールの一部でユーザーに割り当てられている仮想マシンがシャットダウンされると、その仮想マシンはユーザーから切り離され、プールのデフォルト状態に復元され、プールに戻されます (つまり、その仮想マシンを別のユーザーに割り当てることができます)。

7.320.2. manual
リンクのコピー

このポリシーは、プール内の仮想マシンが管理者によって手動で割り当て解除されることを示します。

このポリシーを使用すると、プールの一部である仮想マシンはそのユーザーに割り当てられたままになり、シャットダウン時にその状態が保持されます。仮想マシンをプールに戻すには、管理者がその仮想マシンに対するユーザーのパーミッションを削除して、明示的に割り当てを解除する必要があります。

7.321. VmStatus enum
リンクのコピー

仮想マシンの状態を表すタイプ。

Expand

表7.419 値の概要
名前	Summary
`down`	このステータスは、仮想マシンプロセスが実行されていないことを示します。
`image_locked`	このステータスは、仮想マシンプロセスが実行されておらず、仮想マシンのディスクで起動を妨げる操作が行われていることを示します。
`migrating`	このステータスは、仮想マシンプロセスが実行中であり、仮想マシンがホスト間で移行中であることを示します。
`not_responding`	このステータスは、仮想マシンが応答していないことをハイパーバイザーが検出したことを示します。
`paused`	このステータスは、仮想マシンプロセスが実行中であり、仮想マシンが一時停止していることを示します。
`powering_down`	このステータスは、仮想マシンプロセスが実行中であり、実行を停止しようとしていることを示します。
`powering_up`	このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムがロードされていることを示します。
`reboot_in_progress`	このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムが再起動中であることを示します。
`restoring_state`	このステータスは、仮想マシンプロセスが実行されようとしており、仮想マシンが休止状態から復帰しようとしていることを示します。
`saving_state`	このステータスは、仮想マシンプロセスが実行中であり、仮想マシンが休止状態にあることを示します。
`suspended`	このステータスは、仮想マシンプロセスが実行されておらず、仮想マシンの実行状態が保存されたことを示します。
`unassigned`	このステータスは、無効なステータスを受信したときに設定されます。
`unknown`	このステータスは、システムが仮想マシンのステータスを特定できなかったことを示します。
`up`	このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムがロードされていることを示します。
`wait_for_launch`	このステータスは、仮想マシンプロセスが実行されようとしていることを示します。

7.321.1. paused
リンクのコピー

このステータスは、仮想マシンプロセスが実行中であり、仮想マシンが一時停止していることを示します。これは、仮想マシンが一時停止モードで実行されている場合と、仮想マシンがエラーが原因で自動的に一時停止されている場合の 2 つのケースで発生する可能性があります。

7.321.2. powering_up
リンクのコピー

このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムがロードされていることを示します。ゲストエージェントがインストールされていない場合、このステータスは、仮想マシンの実行時に事前定義された期間 (デフォルトでは 60 秒) に設定されることに注意してください。

7.321.3. restoring_state
リンクのコピー

このステータスは、仮想マシンプロセスが実行されようとしており、仮想マシンが休止状態から復帰しようとしていることを示します。この状態では、仮想マシンの実行状態が復元されています。

7.321.4. saving_state
リンクのコピー

このステータスは、仮想マシンプロセスが実行中であり、仮想マシンが休止状態にあることを示します。この状態では、仮想マシンの実行状態が保存されています。このステータスは、ゲスト OS が休止状態であることを意味するものではないことに注意してください。

7.321.5. suspended
リンクのコピー

このステータスは、仮想マシンプロセスが実行されておらず、仮想マシンの実行状態が保存されたことを示します。このステータスは Down に似ていますが、VM がこのステータスで起動されると、通常の手順を使用して起動される代わりに、保存された実行状態が復元されます。

7.321.6. unknown
リンクのコピー

このステータスは、システムが仮想マシンのステータスを特定できなかったことを示します。このステータスでは、仮想マシンプロセスが実行されているか、実行されていない可能性があります。たとえば、ホストが応答しなくなると、ホストで実行されていた仮想マシンにこのステータスが設定されます。

7.321.7. up
リンクのコピー

このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムがロードされていることを示します。ゲストエージェントがインストールされていない場合、このステータスは、仮想マシンの実行時に事前に定義された期間 (デフォルトでは 60 秒) 後に設定されることに注意してください。

7.321.8. wait_for_launch
リンクのコピー

このステータスは、仮想マシンプロセスが実行されようとしていることを示します。このステータスは、仮想マシンを実行する要求がホストに到着したときに設定されます。仮想マシンプロセスの実行に失敗する可能性があります。

7.322. VmStorageErrorResumeBehaviour enum
リンクのコピー

この仮想マシンにいくつかのディスクがあるストレージが応答しなくなると、仮想マシンは一時停止します。

これは可能なオプションであり、ストレージが再び利用可能になった瞬間に仮想マシンで何が起こるべきかを示しています。

Expand

表7.420 値の概要
名前	Summary
`auto_resume`	ストレージが再び使用可能になると、仮想マシンは自動的に再開されます。
`kill`	仮想マシンはタイムアウト後に強制終了されます (ハイパーバイザーで設定可能)。
`leave_paused`	仮想マシンに何もしません。

7.322.1. auto_resume
リンクのコピー

ストレージが再び使用可能になると、仮想マシンは自動的に再開されます。

これは、4.2 より前で使用できる唯一の動作です。

7.322.2. kill
リンクのコピー

仮想マシンはタイムアウト後に強制終了されます (ハイパーバイザーで設定可能)。

これは、リースを使用する高可用性仮想マシンでサポートされる唯一のオプションです。高可用性の仮想マシンがこのインフラストラクチャーを使用して再起動され、なんらかの形で再開されると、スプリットブレインが発生するリスクがあります。

7.322.3. leave_paused
リンクのコピー

仮想マシンに何もしません。

カスタムフェイルオーバーが実装されていて、ユーザーが仮想マシンを再開しない場合に便利です。

7.323. VmSummary 構造体
リンクのコピー

特定のホスト上の仮想マシンに関連する情報を含むタイプ。

Expand

表7.421 属性の概要
名前	型	Summary
`active`	Integer	ホスト上でアクティブな仮想マシンの数。
`migrating`	Integer	ホストとの間で移行中の仮想マシンの数。
`total`	Integer	ホストに存在する仮想マシンの数。

7.324. VmType enum
リンクのコピー

仮想マシンの最適化対象を表す型。

Expand

表7.422 値の概要
名前	Summary
`desktop`	仮想マシンは、デスクトップとして使用することを目的としています。
`high_performance`	仮想マシンは、高性能仮想マシンとして使用することを目的としています。
`server`	仮想マシンは、サーバーとして使用することを目的としています。

7.324.1. desktop
リンクのコピー

仮想マシンは、デスクトップとして使用することを目的としています。

現時点では、サウンドデバイスが仮想マシンに自動的に追加されることを意味しています。

7.324.2. high_performance
リンクのコピー

仮想マシンは、高性能仮想マシンとして使用することを目的としています。

現在のところ、仮想マシンの設定は可能な限り最高のパフォーマンスで、可能な限りベアメタルに近いパフォーマンスメトリックで実行するように自動的に設定されます。

可能な限り最高のパフォーマンスを得るために推奨される設定の一部は、自動的に設定できません。仮想マシンを実行する前に手動で設定することを推奨します。

次の設定変更は自動的に設定されます。

ヘッドレスモードを有効にする。
シリアルコンソールを有効にする。
パススルーホスト CPU を有効にする。
I/O スレッドを有効にする。
I/O スレッドのピニングを有効にし、ピニングトポロジーを設定する。
準仮想化乱数ジェネレーター PCI (virtio-rng) デバイスを有効にする。
すべての USB デバイスを無効にする。
サウンドカードデバイスを無効にする。
スマートカードデバイスを無効にする。
メモリーバルーンデバイスを無効にします。
ウォッチドッグデバイスを無効にする。
移行を無効にする。
高可用性を無効にする。

次の推奨される設定変更は、ユーザーが手動で設定する必要があります。

CPU ピニングトポロジーを有効にします。
Non-Uniform Memory Access (NUMA) ピニングトポロジーを有効にします。
huge page 設定を有効にして設定します。
カーネルの同一ページマージ (KSM) を無効にします。

7.324.3. server
リンクのコピー

仮想マシンは、サーバーとして使用することを目的としています。

現時点では、サウンドデバイスが仮想マシンに自動的に追加されないことを意味しています。

7.325. VnicPassThrough 構造体
リンクのコピー

Expand

表7.423 属性の概要
名前	型	Summary
`mode`	VnicPassThroughMode	vNIC を仮想デバイスとして実装するか、ホストデバイスへのパススルーとして実装するかを定義します。

7.326. VnicPassThroughMode enum
リンクのコピー

vNIC をパススルーデバイスとして実装するか、仮想デバイスとして実装するかを記述します。

Expand

表7.424 値の概要
名前	Summary
`disabled`	仮想デバイスとして実装されます。
`enabled`	パススルーデバイスとして実装されます。

7.327. VnicProfile 構造体
リンクのコピー

vNIC プロファイルは、個々の NIC に適用できる設定の集まりです。

Expand

表7.425 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`custom_properties`	CustomProperty[]	vNIC プロファイルに適用されるカスタムプロパティー。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`migratable`	ブール値	`pass_through` NIC が移行可能かどうかをマークします。
`name`	String	人間が判読できるプレーンテキストでの名前。
`pass_through`	VnicPassThrough	SR-IOV 対応のホスト NIC へのパススルーを有効にします。
`port_mirroring`	ブール値	ポートミラーリングを有効にします。

7.327.1. migratable
リンクのコピー

pass_through NIC が移行可能かどうかをマークします。

pass_through.mode が 無効 に設定されている場合、このオプションは意味がなく、true と見なされます。リクエストからこのオプションを省略すると、デフォルトで true に設定されます。

仮想マシンを移行する場合、この仮想マシンは、すべての pass_through NIC が migratable としてフラグ付けされている場合にのみ移行されます。

7.327.2. pass_through
リンクのコピー

SR-IOV 対応のホスト NIC へのパススルーを有効にします。

パススルーが有効な場合、vNIC プロファイルを使用すると、SR-IOV が有効なホスト NIC の virtual function (VF) に NIC を直接接続できます。次に、NIC はソフトウェアによるネットワーク仮想化をバイパスして、VF に直接接続してデバイスを割り当てます。

vNIC プロファイルがすでに NIC に接続されている場合、パススルーを有効にできません。vNIC プロファイルでパススルーが有効になっている場合、vNIC プロファイルの qos と port_mirroring は無効になります。

7.327.3. port_mirroring
リンクのコピー

ポートミラーリングを有効にします。

ポートミラーリングは、特定の論理ネットワークとホスト上のレイヤー 3 ネットワークトラフィックを仮想マシンの NIC にコピーします。この仮想マシンは、ネットワークのデバッグとチューニング、侵入検知、および同じホストと論理ネットワーク上の他の仮想マシンの動作の監視に使用できます。コピーされる唯一のトラフィックは、1 つのホスト上の 1 つの論理ネットワークの内部です。ホスト外部のネットワークのトラフィックは増加しませんが、ポートミラーリングが有効になっている仮想マシンは、他の仮想マシンよりも多くのホスト CPU と RAM を使用します。

ポートミラーリングには次の制限があります。

ポートミラーリングが有効になっている vNIC プロファイルを使用した NIC のホットリンクはサポートされていません。
vNIC プロファイルが仮想マシンに接続されている場合は、ポートミラーリングを変更することができません。

上記の制限があるため、追加の専用 vNIC プロファイルでポートミラーリングを有効にすることが推奨されます。

重要

ポートミラーリングを有効にすると、他のネットワークユーザーのプライバシーが低下します。

Expand

表7.426 リンクの概要
名前	型	Summary
`failover`	VnicProfile	ダウンタイムのない SR-IOV 移行向けのフェイルオーバー vNIC プロファイル
`network`	Network	vNIC プロファイルが適用されるネットワークへの参照。
`network_filter`	NetworkFilter	このプロファイルを使用する NIC に適用される最上位のネットワークフィルターへの参照。
`permissions`	Permission[]	vNIC プロファイルの使用を許可する権限。
`qos`	Qos	vNIC プロファイルに適用するサービス品質属性への参照。

7.327.4. network_filter
リンクのコピー

このプロファイルを使用する NIC に適用される最上位のネットワークフィルターへの参照。

ネットワークフィルターは、仮想マシンとの間のネットワークパケットトラフィックを管理する機能を強化します。ネットワークフィルターには、他のフィルターへの参照、トラフィックフィルタリングのルール、または両方の組み合わせが含まれる場合があります。

7.327.5. qos
リンクのコピー

vNIC プロファイルに適用するサービス品質属性への参照。

Quality of Service 属性は、NIC のインバウンドおよびアウトバウンドのネットワークトラフィックを規制します。

7.328. VnicProfileMapping 構造体
リンクのコピー

外部仮想 NIC プロファイルを Red Hat Virtualization Manager に存在するものにマップする非推奨のタイプ。

たとえば、目的の仮想 NIC プロファイルのマッピングに次の 2 行が含まれているとします。

Expand

ソースネットワーク名	ソースネットワークプロファイル名	ターゲット仮想 NIC プロファイル ID
`red`	`gold`	`738dd914-8ec8-4a8b-8628-34672a5d449b`
`blue`	`silver`	`892a12ec-2028-4451-80aa-ff3bf55d6bac`

次の形式は 4.2.1 以降非推奨となり、今後削除される予定です。

<vnic_profile_mappings>
  <vnic_profile_mapping>
    <source_network_name>red</source_network_name>
    <source_network_profile_name>gold</source_network_profile_name>
    <target_vnic_profile id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
  </vnic_profile_mapping>
  <vnic_profile_mapping>
    <source_network_name>blue</source_network_name>
    <source_network_profile_name>silver</source_network_profile_name>
    <target_vnic_profile id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/>
  </vnic_profile_mapping>
</vnic_profile_mappings>

<vnic_profile_mappings>
  <vnic_profile_mapping>
    <source_network_name>red</source_network_name>
    <source_network_profile_name>gold</source_network_profile_name>
    <target_vnic_profile id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
  </vnic_profile_mapping>
  <vnic_profile_mapping>
    <source_network_name>blue</source_network_name>
    <source_network_profile_name>silver</source_network_profile_name>
    <target_vnic_profile id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/>
  </vnic_profile_mapping>
</vnic_profile_mappings>

Copy to Clipboard

Toggle word wrap

Expand

表7.427 属性の概要
名前	型	Summary
`source_network_name`	String	外部ネットワークの名前を記述する非推奨の属性。
`source_network_profile_name`	String	外部ネットワークプロファイルの名前を記述する非推奨の属性。

7.328.1. source_network_name
リンクのコピー

外部ネットワークの名前を記述する非推奨の属性。

警告

この属性は、エンジンのバージョン 4.2.1 以降は非推奨となっており、後方互換性のためにのみ保持されていることに注意してください。これは今後削除されます。

7.328.2. source_network_profile_name
リンクのコピー

外部ネットワークプロファイルの名前を記述する非推奨の属性。

警告

Expand

表7.428 リンクの概要
名前	型	Summary
`target_vnic_profile`	VnicProfile	既存の仮想 NIC プロファイルを記述する非推奨の属性。

7.328.3. target_vnic_profile
リンクのコピー

既存の仮想 NIC プロファイルを記述する非推奨の属性。

警告

7.329. VolumeGroup struct
リンクのコピー

Expand

表7.429 属性の概要
名前	型	Summary
`id`	String
`logical_units`	LogicalUnit[]
`name`	String

7.330. Watchdog 構造体
リンクのコピー

このタイプは、ウォッチドッグ設定を表します。

Expand

表7.430 属性の概要
名前	型	Summary
`action`	WatchdogAction	ウォッチドッグがトリガーされたときに実行されるウォッチドッグアクション。
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`id`	String	一意の ID
`model`	WatchdogModel	ウォッチドッグデバイスのモデル。
`name`	String	人間が判読できるプレーンテキストでの名前。

7.330.1. model
リンクのコピー

ウォッチドッグデバイスのモデル。現在、I6300ESB のみがサポートされています。

Expand

表7.431 リンクの概要
名前	型	Summary
`instance_type`	InstanceType	オプションで、デバイスが使用するインスタンスタイプへの参照。
`template`	テンプレート	オプションで、デバイスが使用するテンプレートへの参照。
`vm`	Vm	この要素は使用せず、代わりに `vms` を使用してください。
`vms`	Vm[]	このデバイスを使用する仮想マシンへの参照。

7.330.2. vms
リンクのコピー

7.331. WatchdogAction enum
リンクのコピー

このタイプは、利用可能なウォッチドッグアクションを記述します。

Expand

表7.432 値の概要
名前	Summary
`dump`	仮想マシンプロセスは、ホストのデフォルトパスにコアダンプされます。
`none`	ウォッチドッグアクションがトリガーされる場合、アクションは実行されません。
`pause`	ウォッチドッグアクションがトリガーされると、仮想マシンは一時停止します。
`poweroff`	ウォッチドッグアクションがトリガーされると、仮想マシンの電源がオフになります。
`reset`	ウォッチドッグアクションがトリガーされると、仮想マシンが再起動されます。

7.331.1. none
リンクのコピー

ウォッチドッグアクションがトリガーされる場合、アクションは実行されません。ただし、ログメッセージは引き続き生成されます。

7.332. WatchdogModel enum
リンクのコピー

このタイプはウォッチドッグモデルを表します。

Expand

表7.433 値の概要
名前	Summary
`diag288`	S390X マシンのウォッチドッグモデル。
`i6300esb`	PCI ベースのウォッチドッグモデル。

7.332.1. diag288
リンクのコピー

S390X マシンのウォッチドッグモデル。

S390X には、DIAG288 命令を介して制御される統合ウォッチドッグファシリティーがあります。このモデルは、S390X 仮想マシンに使用します。

7.332.2. i6300esb
リンクのコピー

PCI ベースのウォッチドッグモデル。

x86_64 および PPC64 仮想マシンには I6300ESB ウォッチドッグを使用します。

7.333. Weight 構造体
リンクのコピー

Expand

表7.434 属性の概要
名前	型	Summary
`comment`	String	このオブジェクトに関するコメントを含むフリーテキスト。
`description`	String	プレーンテキストでの人間が判読できる説明。
`factor`	Integer
`id`	String	一意の ID
`name`	String	人間が判読できるプレーンテキストでの名前。

Expand

表7.435 リンクの概要
名前	型	Summary
`scheduling_policy`	SchedulingPolicy
`scheduling_policy_unit`	SchedulingPolicyUnit

付録A プリミティブ型
リンクのコピー

このセクションでは、API でサポートされているプリミティブデータ型を説明します。

A.1. 文字列プリミティブ
リンクのコピー

Unicode 文字の有限シーケンス。

A.2. ブール値プリミティブ
リンクのコピー

数理論理学で使用される false の概念と true の概念を表します。

有効な値は文字列 false と true です。

エンジンは大文字と小文字を区別しないため、たとえば False と FALSE はどちらも有効な値です。ただし、サーバーは常に小文字の値を返します。

古いバージョンのエンジンとの後方互換性のために、値 0 と 1 も使用できます。値 0 は false を、1 は true を意味します。これらの値のサポートは今後削除される可能性があるため、これらの値の使用は避けてください。

A.3. 整数プリミティブ
リンクのコピー

整数の数学的概念を表します。

有効な値は、10 進数の有限シーケンスです。

現在，エンジンはこの型を符号付き 32 ビット整数で実装しており，最小値は 2³¹ (-2147483648) で、最大値は 2³¹-1 (2147483647) となっています。

ただし、システムには、32 ビットで可能な値の範囲では不十分な属性がいくつかあります。これらの例外的なケースでは、エンジンは、特に次の属性に対して 64 ビット整数を使用します。

Disk.actual_size
Disk.provisioned_size
GlusterClient.bytes_read
GlusterClient.bytes_written
Host.max_scheduling_memory
Host.memory
HostNic.speed
LogicalUnit.size
MemoryPolicy.guaranteed
NumaNode.memory
QuotaStorageLimit.limit
StorageDomain.available
StorageDomain.used
StorageDomain.committed
VmBase.memory

これらの例外の場合、最小値は -2⁶³ (-9223372036854775808) で、最大値は 2⁶³-1 (9223372036854775807) です。

注記

今後、整数型は無制限の精度の整数を使用して実装されるため、上記の制限と例外は最終的にはなくなります。

A.4. 10 進プリミティブ型
リンクのコピー

実数の数学的概念を表します。

現在、エンジンは 32 ビット IEEE 754 単精度浮動小数点数を使用してこの型を実装しています。

一部の属性では、この精度では十分ではありません。これらの例外的なケースでは、エンジンは 64 ビットの倍精度浮動小数点数を、特に次の属性に使用します。

QuotaStorageLimit.usage
QuotaStorageLimit.memory_limit
QuotaStorageLimit.memory_usage

注記

今後、10 進数型は無制限の精度の 10 進数を使用して実装されるため、上記の制限と例外は最終的にはなくなります。

A.5. Date プリミティブ
リンクのコピー

日付と時刻を表します。

エンジンによって返される形式は、XML を要求するときに XML スキーマ仕様に記述されている形式です。たとえば、次のようなリクエストを送信して、仮想マシンの XML 表現を取得するとします。

GET /ovirt-engine/api/vms/123
Accept: application/xml

GET /ovirt-engine/api/vms/123
Accept: application/xml

Copy to Clipboard

Toggle word wrap

応答本文には、次の XML ドキュメントが含まれます。

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <creation_time>2016-09-08T09:53:35.138+02:00</creation_time>
  ...
</vm>

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <creation_time>2016-09-08T09:53:35.138+02:00</creation_time>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

JSON 表現を要求する場合、エンジンは別の形式を使用します。つまり、1970 年 1 月 1 日からのミリ秒数を含む整数 (エポック時間 とも呼ばれます)。たとえば、次のようなリクエストを送信して、仮想マシンの JSON 表現を取得するとします。

GET /ovirt-engine/api/vms/123
Accept: application/json

GET /ovirt-engine/api/vms/123
Accept: application/json

Copy to Clipboard

Toggle word wrap

応答本文には、次の JSON ドキュメントが含まれます。

{
  "id": "123",
  "href="/ovirt-engine/api/vms/123",
  ...
  "creation_time": 1472564909990,
  ...
}

{
  "id": "123",
  "href="/ovirt-engine/api/vms/123",
  ...
  "creation_time": 1472564909990,
  ...
}

Copy to Clipboard

Toggle word wrap

注記

どちらの場合も、エンジンによって返される日付は、エンジンが実行されているサーバーで設定されたタイムゾーンを使用します。これらの例では、タイムゾーンは UTC+2 です。

付録B API バージョン 4 の変更点
リンクのコピー

このセクションでは、API のバージョン 4 以降に導入された下位互換性を確保できない変更を列挙します。

B.1. API バージョン 4.0 での変更点 (バージョン 3.6 の後継)
リンクのコピー

B.1.1. YAML サポートの削除
リンクのコピー

YAML のサポートは完全に削除されました。

B.1.2. 複合型の名前変更
リンクのコピー

次の XML スキーマ複合型の名前が変更されました。

Expand

Version 3	Version 4
`API`	`Api`
`CPU`	`Cpu`
`CPU`	`Cpus`
`CdRom`	`Cdrom`
`CdRoms`	`Cdroms`
`DNS`	`Dns`
`GuestNicConfiguration`	`NicConfiguration`
`GuestNicsConfiguration`	`NicConfigurations`
`HostNICStates`	`HostNicStates`
`HostNIC`	`HostNic`
`HostStorage`	`HostStorages`
`IO`	`Io`
`IP`	`Ip`
`IPs`	`Ips`
`KSM`	`Ksm`
`MAC`	`Mac`
`NIC`	`Nic`
`PreviewVMs`	`PreviewVms`
`QoS`	`Qos`
`QoSs`	`Qoss`
`RSDL`	`Rsdl`
`SELinux`	`SeLinux`
`SPM`	`Spm`
`SSHPublicKey`	`SshPublicKey`
`SSHPublicKeys`	`SshPublicKeys`
`SSH`	`Ssh`
`SkipIfSDActive`	`SkipIfSdActive`
`Slaves`	`HostNics`
`ストレージ`	`HostStorage`
`SupportedVersions`	`バージョン`
`VCpuPin`	`VcpuPin`
`VLAN`	`Vlan`
`VM`	`Vm`
`仮想マシン`	`Vms`
`VirtIO_SCSI`	`VirtioScsi`
`WatchDog`	`Watchdog`
`WatchDogs`	`Watchdogs`

B.1.3. Status タイプの enum 型への置き換え
リンクのコピー

現在、さまざまなオブジェクトのステータスは、ステータスを説明する state 文字列と追加の詳細を示す別の detail 文字列を含む Status タイプを使用して報告されます。たとえば、IO エラーが原因で一時停止している仮想マシンのステータスは、現在次のように報告されています。

<vm>
  ...
  <status>
    <state>paused</state>
    <detail>eio</detail>
  </status>
  ...
</vm>

<vm>
  ...
  <status>
    <state>paused</state>
    <detail>eio</detail>
  </status>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

API のバージョン 4 では、この Status 型が削除され、enum 型に置き換えられました。追加の 詳細 文字列が必要な場合は、追加の status_detail 属性に置き換えられています。たとえば、同じ仮想マシンのステータスは次のように報告されます。

<vm>
  ...
  <status>paused</status>
  <status_detail>eio</status_detail>
  ...
</vm>

<vm>
  ...
  <status>paused</status>
  <status_detail>eio</status_detail>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

B.1.4. NIC network と port_mirroring プロパティーの削除
リンクのコピー

NIC network および port_mirroring 要素は vnic_profile 要素に置き換えられたので、ネットワークおよびポートミラーリング設定を指定する代わりに NIC を作成または更新する場合には、これらは vNIC プロファイルの作成時に指定されていました。

POST /ovirt-engine/api/vnicprofiles

POST /ovirt-engine/api/vnicprofiles

Copy to Clipboard

Toggle word wrap

<vnic_profile>
  <name>myprofile</name>
  <network id="..."/>
  <port_mirroring>true</port_mirroring>
</vnic_profile>

<vnic_profile>
  <name>myprofile</name>
  <network id="..."/>
  <port_mirroring>true</port_mirroring>
</vnic_profile>

Copy to Clipboard

Toggle word wrap

次に、NIC が作成されるか、既存の vNIC プロファイルを参照します。

PUT /ovirt-engine/api/vms/123/nics/456

PUT /ovirt-engine/api/vms/123/nics/456

Copy to Clipboard

Toggle word wrap

<nic>
  <vnic_profile id="/vnicprofiles/...">
</nic>

<nic>
  <vnic_profile id="/vnicprofiles/...">
</nic>

Copy to Clipboard

Toggle word wrap

古い要素とその意味は後方互換性のために保持されていましたが、現在は完全に削除されています。

network 要素は initialization 要素でまだ使用されているため、XML スキーマから削除されていませんが、NIC の作成または更新時に指定された場合は完全に無視されることに注意してください。

B.1.5. NIC active プロパティーの削除
リンクのコピー

NIC の active プロパティーは、しばらく前に plugged に置き換えられました。現在は完全に削除されています。

B.1.6. ディスク type プロパティーの削除
リンクのコピー

ディスクの type プロパティーは削除されましたが、XML スキーマに保持され、無視されます。現在は完全に削除されています。

B.1.7. ディスク size プロパティーの削除
リンクのコピー

ディスク size プロパティーは、だいぶ前に provisioned_size に置き換えられています。現在は完全に削除されています。

B.1.8. VM を単一のホストに固定するためのサポートを削除
リンクのコピー

バージョン 3.6 より前の API では、VM エンティティーの placement_policy 要素を使用して、VM を単一のホストにピニングすることができました。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

<vm>
  <placement_policy>
    <host id="456"/>
  </placement_policy>
<vm>

<vm>
  <placement_policy>
    <host id="456"/>
  </placement_policy>
<vm>

Copy to Clipboard

Toggle word wrap

バージョン 3.6 では、複数のホストをサポートするようにこの機能が強化され、新しい hosts 要素が追加されました。

PUT /ovirt-engine/api/vms/123

PUT /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

<vm>
  <placement_policy>
    <hosts>
      <host id="456"/>
      <host id="789"/>
      ...
    </hosts>
  </placement_policy>
<vm>

<vm>
  <placement_policy>
    <hosts>
      <host id="456"/>
      <host id="789"/>
      ...
    </hosts>
  </placement_policy>
<vm>

Copy to Clipboard

Toggle word wrap

後方互換性を維持するために、単一の host 要素が保持されました。4.0 ではこれが削除されたため、単一のホストにピニングする場合でも、アプリケーションは hosts 要素を使用する必要があります。

B.1.9. capabilities.permits 要素の削除
リンクのコピー

permits のリストは、クラスターレベルごとに異なる可能性があり、かなり前に version 要素に追加されましたが、後方互換性のために、capabilities 要素にも保持されています。

4.0 では、capabilities サービスが完全に削除され、新しい clusterlevels サービスに置き換えられました。クラスターレベル 4.0 でサポートされる permits を見つけるには、以下のようなリクエストを使用する必要があります。

GET /ovirt-engine/api/clusterlevels/4.0

GET /ovirt-engine/api/clusterlevels/4.0

Copy to Clipboard

Toggle word wrap

結果は、そのクラスターレベルに固有の情報、特にサポートされている一連の permits を含むドキュメントになります。

<cluster_level id="4.0" href="/clusterlevels/4.0">
  ...
  <permits>
    <permit id="1">
      <name>create_vm</name>
      <administrative>false</administrative>
    </permit>
    ...
  </permits>
</cluster_level>

<cluster_level id="4.0" href="/clusterlevels/4.0">
  ...
  <permits>
    <permit id="1">
      <name>create_vm</name>
      <administrative>false</administrative>
    </permit>
    ...
  </permits>
</cluster_level>

Copy to Clipboard

Toggle word wrap

B.1.10. storage_manager 要素の削除
リンクのコピー

storage_manager 要素は、しばらく前に spm 要素に置き換えられました。古いものは後方互換性のために保持されていましたが、現在は完全に削除されています。

B.1.11. データセンターの storage_type 要素の削除
リンクのコピー

データセンターは、以前は特定のストレージタイプ (NFS、ファイバーチャネル、iSCSI など) に関連付けられていましたが、しばらくして変更され、ローカルストレージと共有ストレージの 2 つのタイプのみになりました。これを示すために新しい local 要素が導入され、古い storage_type 要素は後方互換性のために保持されました。この古い要素は完全に削除されました。

B.1.12. timezone 要素の削除
リンクのコピー

タイムゾーンを表す timezone 要素を格納するために使用される VM リソース。この要素は文字列のみを許可していました。

<vm>
  <timezone>Europe/Madrid</timezone>
</vm>

<vm>
  <timezone>Europe/Madrid</timezone>
</vm>

Copy to Clipboard

Toggle word wrap

これはエクステンションを許可せず、UTC オフセットを追加する必要があったため、新しい構造化された time_zone 要素に置き換えられました。

<vm>
  <time_zone>
    <name>Europe/Madrid</name>
    <utc_offset>GMT+1</utc_offset>
  </time_zone>
</vm>

<vm>
  <time_zone>
    <name>Europe/Madrid</name>
    <utc_offset>GMT+1</utc_offset>
  </time_zone>
</vm>

Copy to Clipboard

Toggle word wrap

古い timezone 要素は保持されていましたが、現在は完全に削除されています。

B.1.13. guest_info 要素の削除
リンクのコピー

guest_info 要素は、IP アドレスや完全修飾ホスト名など、ゲストエージェントによって収集された情報を保持するために使用されていました。この情報は他の場所でも入手できます。たとえば、IP アドレスは VM リソース内で使用できます。

GET /ovirt-engine/api/vms/123

GET /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

<vm>
  <guest_info>
    <ips>
      <ip address="192.168.122.30"/>
    </ips>
    <fqdn>myvm.example.com</fqdn>
  </guest_info>
</vm>

<vm>
  <guest_info>
    <ips>
      <ip address="192.168.122.30"/>
    </ips>
    <fqdn>myvm.example.com</fqdn>
  </guest_info>
</vm>

Copy to Clipboard

Toggle word wrap

また、NIC リソース内で、新しい reported_devices 要素を使用します。

GET /ovirt-engine/api/vms/{vm:id}/nics/{nic:id}

GET /ovirt-engine/api/vms/{vm:id}/nics/{nic:id}

Copy to Clipboard

Toggle word wrap

<nic>
  <reported_devices>
    <reported_device>
      <name>eth0</name>
      <mac address="00:1a:4a:b5:4c:94"/>
      <ips>
        <ip address="192.168.1.115" version="v4"/>
        <ip address="fe80::21a:4aff:feb5:4c94" version="v6"/>
        <ip address="::1:21a:4aff:feb5:4c94" version="v6"/>
      </ips>
    </reported_device>
  </reported_devices>
</nic>

<nic>
  <reported_devices>
    <reported_device>
      <name>eth0</name>
      <mac address="00:1a:4a:b5:4c:94"/>
      <ips>
        <ip address="192.168.1.115" version="v4"/>
        <ip address="fe80::21a:4aff:feb5:4c94" version="v6"/>
        <ip address="::1:21a:4aff:feb5:4c94" version="v6"/>
      </ips>
    </reported_device>
  </reported_devices>
</nic>

Copy to Clipboard

Toggle word wrap

さらに、この新しい reported_devices 要素は、複数の IP アドレス、MAC アドレスなど、より完全な情報を提供します。

この重複を取り除くために、guest_info 要素が削除されました。

完全修飾ドメイン名をサポートするために、新しい fqdn 要素が VM リソースに追加されました。

GET /ovirt-engine/api/vms/123

GET /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

<vm>
  <fqdn>myvm.example.com</fqdn>
</vms>

<vm>
  <fqdn>myvm.example.com</fqdn>
</vms>

Copy to Clipboard

Toggle word wrap

これには、guest_info.fqdn に含まれていたものと同じ情報が含まれます。

B.1.14. CPU id 属性の type 要素への置き換え
リンクのコピー

cpu 要素には、CPU のタイプを示す id 属性がありました。

<cpu id="Intel Nehalem Family">
  <architecture>X86_64</architecture>
  ...
</cpu>

<cpu id="Intel Nehalem Family">
  <architecture>X86_64</architecture>
  ...
</cpu>

Copy to Clipboard

Toggle word wrap

これは、id 属性が不透明な識別子に使用される API モデルの残りの要素と矛盾しています。この id 属性は新しい type 要素に置き換えられました。

<cpu>
  <type>Intel Nehalem Family</type>
  <architecture>X86_64</architecture>
</cpu>

<cpu>
  <type>Intel Nehalem Family</type>
  <architecture>X86_64</architecture>
</cpu>

Copy to Clipboard

Toggle word wrap

B.1.15. CPU トポロジーで属性の代わりに要素を使用する
リンクのコピー

以前は、CPU トポロジー要素はそのプロパティーに属性を使用していました。

<cpu>
  <topology sockets="1" cores="1" threads="1"/>
  ...
</cpu>

<cpu>
  <topology sockets="1" cores="1" threads="1"/>
  ...
</cpu>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<cpu>
  <topology>
    <sockets>1<sockets>
    <cores>1<cores>
    <threads>1<threads>
  </topology>
  ...
</cpu>

<cpu>
  <topology>
    <sockets>1<sockets>
    <cores>1<cores>
    <threads>1<threads>
  </topology>
  ...
</cpu>

Copy to Clipboard

Toggle word wrap

B.1.16. VCPU ピンで属性の代わりに要素を使用する
リンクのコピー

以前は、VCPU ピン要素はそのプロパティーに属性を使用していました。

<cpu_tune>
  <vcpu_pin vcpu="0" cpu_set="0"/>
</cpu_tune>

<cpu_tune>
  <vcpu_pin vcpu="0" cpu_set="0"/>
</cpu_tune>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<cpu_tune>
  <vcpu_pin>
    <vcpu>0</vcpu>
    <cpu_set>0</cpu_set>
  </vcpu_pin>
</cpu_tune>

<cpu_tune>
  <vcpu_pin>
    <vcpu>0</vcpu>
    <cpu_set>0</cpu_set>
  </vcpu_pin>
</cpu_tune>

Copy to Clipboard

Toggle word wrap

B.1.17. VCPU ピンで属性の代わりに要素を使用する
リンクのコピー

以前は、version 要素はそのプロパティーに属性を使用していました:

<version major="3" minor="5" ../>

<version major="3" minor="5" ../>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<version>
  <major>3</minor>
  <minor>5</minor>
  ...
</version>

<version>
  <major>3</minor>
  <minor>5</minor>
  ...
</version>

Copy to Clipboard

Toggle word wrap

B.1.18. メモリーのオーバーコミットで属性の代わりに要素を使用する
リンクのコピー

以前は、overcommit 要素はそのプロパティーに属性を使用していました。

<memory_policy>
  <overcommit percent="100"/>
  ...
</memory_policy>

<memory_policy>
  <overcommit percent="100"/>
  ...
</memory_policy>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<memory_policy>
  <overcommit>
    <percent>100</percent>
  </overcommit>
  ...
</memory_policy>

<memory_policy>
  <overcommit>
    <percent>100</percent>
  </overcommit>
  ...
</memory_policy>

Copy to Clipboard

Toggle word wrap

B.1.19. console で属性の代わりに要素を使用する
リンクのコピー

以前は、console 要素はそのプロパティーに属性を使用していました:

<console enabled="true"/>

<console enabled="true"/>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<console>
  <enabled>true</enabled>
</console>

<console>
  <enabled>true</enabled>
</console>

Copy to Clipboard

Toggle word wrap

B.1.20. VIRTIO SCSI で属性の代わりに要素を使用する
リンクのコピー

以前は、VIRTIO ISCSI 要素はそのプロパティーに属性を使用していました。

<virtio_scsi enabled="true"/>

<virtio_scsi enabled="true"/>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<virtio_scsi>
  <enabled>true</enabled>
</virtio_scsi>

<virtio_scsi>
  <enabled>true</enabled>
</virtio_scsi>

Copy to Clipboard

Toggle word wrap

B.1.21. 電源管理エージェント type に属性ではなく要素を使用する
リンクのコピー

電源管理 type プロパティーは属性として表されていました。

<agent type="apc">
  <username>myuser</username>
  ...
</agent>

<agent type="apc">
  <username>myuser</username>
  ...
</agent>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。内部要素に置き換えられました。

<agent>
  <type>apc</type>
  <username>myuser</username>
  ...
</agent>

<agent>
  <type>apc</type>
  <username>myuser</username>
  ...
</agent>

Copy to Clipboard

Toggle word wrap

B.1.22. 電源管理エージェントオプションで属性の代わりに要素を使用する
リンクのコピー

以前は、電源管理エージェントの option 要素は、そのプロパティーに属性を使用していました。

<options>
  <option name="port" value="22"/>
  <option name="slot" value="5"/>
  ...
</options>

<options>
  <option name="port" value="22"/>
  <option name="slot" value="5"/>
  ...
</options>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<options>
  <option>
    <name>port</name>
    <value>22</value>
  </option>
  <option>
    <name>slot</name>
    <value>5</value>
  </option>
  ...
</options>

<options>
  <option>
    <name>port</name>
    <value>22</value>
  </option>
  <option>
    <name>slot</name>
    <value>5</value>
  </option>
  ...
</options>

Copy to Clipboard

Toggle word wrap

B.1.23. IP アドレスで属性の代わりに要素を使用する
リンクのコピー

以前は、IP アドレス要素はそのプロパティーに属性を使用していました。

<ip address="192.168.122.1" netmask="255.255.255.0"/>

<ip address="192.168.122.1" netmask="255.255.255.0"/>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<ip>
  <address>192.168.122.1</address>
  <netmask>255.255.255.0</netmask>
</ip>

<ip>
  <address>192.168.122.1</address>
  <netmask>255.255.255.0</netmask>
</ip>

Copy to Clipboard

Toggle word wrap

B.1.24. MAC アドレスで属性の代わりに要素を使用する
リンクのコピー

以前は、MAC アドレス要素はそのプロパティーに属性を使用していました。

<mac address="66:f2:c5:5f:bb:8d"/>

<mac address="66:f2:c5:5f:bb:8d"/>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<mac>
  <address>66:f2:c5:5f:bb:8d</address>
</mac>

<mac>
  <address>66:f2:c5:5f:bb:8d</address>
</mac>

Copy to Clipboard

Toggle word wrap

B.1.25. ブートデバイスで属性の代わりに要素を使用する
リンクのコピー

以前は、ブートデバイス要素はそのプロパティーに属性を使用していました。

<boot dev="cdrom"/>

<boot dev="cdrom"/>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。それらは内部要素に置き換えられました:

<boot>
  <dev>cdrom</dev>
</boot>

<boot>
  <dev>cdrom</dev>
</boot>

Copy to Clipboard

Toggle word wrap

B.1.26. オペレーティングシステム type に属性の代わりに要素を使用する
リンクのコピー

オペレーティングシステム type プロパティーは属性として表されていました。

<os type="other">
  ...
</os>

<os type="other">
  ...
</os>

Copy to Clipboard

Toggle word wrap

これは、API の一般的な慣行に反しています。内部要素に置き換えられました。

<os>
  <type>other</type>
  ...
</os>

<os>
  <type>other</type>
  ...
</os>

Copy to Clipboard

Toggle word wrap

B.1.27. ホストを取得するリクエストからの force パラメーターの削除
リンクのコピー

データベースからデータを取得する前に、ホストのデータを更新する (VDSM を呼び出してホストの機能とデバイスをリロードする) 必要があることを示す force マトリクスパラメーターをサポートするために使用されるホストを取得するリクエスト。

GET /ovirt-engine/api/hosts/123;force

GET /ovirt-engine/api/hosts/123;force

Copy to Clipboard

Toggle word wrap

この force パラメーターは、ホストの refresh アクションに取って代わられましたが、後方互換性のために保持されています。現在は完全に削除されています。この機能を必要とするアプリケーションは、2 つのリクエストを実行する必要があります。1 つ目は、ホストをリフレッシュするためのリクエストです。

POST /ovirt-engine/api/hosts/123/refresh

POST /ovirt-engine/api/hosts/123/refresh

Copy to Clipboard

Toggle word wrap

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

2 つ目は、force パラメーターなしでそれを取得するためのリクエストです。

GET /ovirt-engine/api/hosts/123

GET /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

B.1.28. 非推奨のホスト電源管理設定の削除
リンクのコピー

ホストの電源管理設定は、以前はホストリソースの一部であり、組み込みの設定要素を使用していました。

<power_management type="apc">
  <enabled>true</enabled>
  <address>myaddress</address>
  <username>myaddress</username>
  <options>
    <option name="port" value="22/>
    </option name="slot" value="5/>
  </options>
  ...
</power_management>

<power_management type="apc">
  <enabled>true</enabled>
  <address>myaddress</address>
  <username>myaddress</username>
  <options>
    <option name="port" value="22/>
    </option name="slot" value="5/>
  </options>
  ...
</power_management>

Copy to Clipboard

Toggle word wrap

これは、複数の電源管理エージェントをサポートするために、少し前に新しい /hosts/123/fenceagents コレクションを導入することで変更されました。

古い type 属性、古い address 要素、username 要素、password 要素、および power_management の内部に直接ある agents 要素は、後方互換性のために保持されました。これらの要素はすべて完全に削除されたため、電源管理エージェントをクエリーまたは変更する方法は、現時点では /hosts/123/fenceagents サブコレクションのみになります。

B.1.29. 複数の boot の代わりに複数の boot.devices.device を使用する
リンクのコピー

これまで、仮想マシンの起動時にブートシーケンスを指定する方法は、それぞれが dev 要素を含む複数の boot 要素を使用することでした。たとえば、仮想マシンが最初に CDROM から起動し、次にハードディスクから起動するように指定するには、以下のリクエストが使用されました。

POST /ovirt-engine/api/vms/123/start

POST /ovirt-engine/api/vms/123/start

Copy to Clipboard

Toggle word wrap

<action>
  <vm>
    ...
    <boot>
      <dev>cdrom</dev>
    </boot>
    <boot>
      <dev>hd</dev>
    </boot>
  </vm>
</action>

<action>
  <vm>
    ...
    <boot>
      <dev>cdrom</dev>
    </boot>
    <boot>
      <dev>hd</dev>
    </boot>
  </vm>
</action>

Copy to Clipboard

Toggle word wrap

API の他の部分での一般的な方法は、配列をラッパー要素で表すことです。その場合、そのラッパー要素に boots という名前を付けることができますが、ここで複数の値を指定できるのはブートシーケンスではなくブートデバイスであるため、あまり意味がありません。この矛盾を修正するために、これは複数のデバイスを含むことができる単一の boot 要素に置き換えられました。

POST /ovirt-engine/api/vms/123/start

POST /ovirt-engine/api/vms/123/start

Copy to Clipboard

Toggle word wrap

<action>
  <vm>
    ...
    <boot>
      <devices>
        <device>cdrom</device>
        <device>hd</device>
      </devices>
    </boot>
  </vm>
</action>

<action>
  <vm>
    ...
    <boot>
      <devices>
        <device>cdrom</device>
        <device>hd</device>
      </devices>
    </boot>
  </vm>
</action>

Copy to Clipboard

Toggle word wrap

B.1.30. disks.clone と disks.detach_only 要素の削除
リンクのコピー

これらの要素は実際にはディスクの表現の一部ではなく、仮想マシンを追加および削除する操作のパラメーターです。

新しい仮想マシンのディスクのクローンを作成する必要があることを示すために、disks.clone 要素が使用されました。

POST /ovirt-engine/api/vms

POST /ovirt-engine/api/vms

Copy to Clipboard

Toggle word wrap

<vm>
  ...
  <disks>
    <clone>true</clone>
  </disks>
<vm>

<vm>
  ...
  <disks>
    <clone>true</clone>
  </disks>
<vm>

Copy to Clipboard

Toggle word wrap

これは現在削除され、新しい clone クエリーパラメーターに置き換えられています。

POST /ovirt-engine/api/vms?clone=true

POST /ovirt-engine/api/vms?clone=true

Copy to Clipboard

Toggle word wrap

<vm>
  ...
</vm>

<vm>
  ...
</vm>

Copy to Clipboard

Toggle word wrap

disks.detach_only 要素は、仮想マシンの削除時に、ディスクを削除する必要はなく、仮想マシンから切り離すだけであることを指定するために使用されていました。

DELETE /ovirt-engine/api/vms/123

DELETE /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

<action>
  <vm>
    <disks>
      <detach_only>true</detach_only>
    </disks>
  </vm>
</action>

<action>
  <vm>
    <disks>
      <detach_only>true</detach_only>
    </disks>
  </vm>
</action>

Copy to Clipboard

Toggle word wrap

これは削除され、新しい detach_only クエリーパラメーターに置き換えられました。

DELETE /ovirt-engine/api/vms/123?detach_only=true

DELETE /ovirt-engine/api/vms/123?detach_only=true

Copy to Clipboard

Toggle word wrap

B.1.31. 要素 vmpool の名前を vm_pool に変更する
リンクのコピー

仮想マシンのプールを表す要素の名前は、以前は vmpool および vmpools でした。複合タイプ (この場合は VmPool と VmPools) と要素の名前間での対応を統一するために、vm_pool と vm_pools に改名されました。

B.1.32. 複数の logical_unit の代わりに logical_units を使用する
リンクのコピー

ボリュームグループの一部である論理ユニットは、無制限数の logical_unit 要素として報告されていました。たとえば、ストレージドメインの詳細を報告する場合は、以下のようになります。

GET /ovirt-engine/api/storagedomains/123

GET /ovirt-engine/api/storagedomains/123

Copy to Clipboard

Toggle word wrap

<storage_domain>
  ...
  <storage>
    ...
    <volume_group>
      <logical_unit>
        <!-- First LU -->
      </logical_unit>
      <logical_unit>
        <!-- Second LU -->
      </logical_unit>
      ...
    </volume_group>
  </storage>
</storage_domain>

<storage_domain>
  ...
  <storage>
    ...
    <volume_group>
      <logical_unit>
        <!-- First LU -->
      </logical_unit>
      <logical_unit>
        <!-- Second LU -->
      </logical_unit>
      ...
    </volume_group>
  </storage>
</storage_domain>

Copy to Clipboard

Toggle word wrap

要素のリストは常に要素でラップされるため、これは API の通常の慣行に反します。これは現在修正されているため、論理ユニットのリストは logical_units 要素でラップされます。

GET /ovirt-engine/api/storagedomains/123

GET /ovirt-engine/api/storagedomains/123

Copy to Clipboard

Toggle word wrap

<storage_domain>
  ...
  <storage>
    ...
    <volume_group>
      <logical_units>
        <logical_unit>
          <!-- First LU -->
        </logical_unit>
        <logical_unit>
          <!-- Second LU -->
        </logical_unit>
        ...
      </logical_units>
    </volume_group>
  </storage>
</storage_domain>

<storage_domain>
  ...
  <storage>
    ...
    <volume_group>
      <logical_units>
        <logical_unit>
          <!-- First LU -->
        </logical_unit>
        <logical_unit>
          <!-- Second LU -->
        </logical_unit>
        ...
      </logical_units>
    </volume_group>
  </storage>
</storage_domain>

Copy to Clipboard

Toggle word wrap

B.1.33. snapshots.collapse_snapshots 要素の削除
リンクのコピー

この要素は実際にはスナップショットの表現の一部ではありませんが、エクスポートストレージドメインから仮想マシンをインポートする操作のパラメーターです。

POST /ovirt-engine/api/storagedomains/123/vms/456/import

POST /ovirt-engine/api/storagedomains/123/vms/456/import

Copy to Clipboard

Toggle word wrap

<action>
  <vm>
    <snapshots>
      <collapse_snapshots>true</collapse_snapshots>
    </snapshots>
  </vm>
</action>

<action>
  <vm>
    <snapshots>
      <collapse_snapshots>true</collapse_snapshots>
    </snapshots>
  </vm>
</action>

Copy to Clipboard

Toggle word wrap

これは削除され、新しい collapse_snapshots クエリーパラメーターに置き換えられました。

POST /ovirt-engine/api/storagedomains/123/vms/456/import?collapse_snapshots=true

POST /ovirt-engine/api/storagedomains/123/vms/456/import?collapse_snapshots=true

Copy to Clipboard

Toggle word wrap

<action/>

<action/>

Copy to Clipboard

Toggle word wrap

B.1.34. storage と host_storage 要素の名前の変更
リンクのコピー

ホストストレージコレクションは、storage 要素と host_storage 要素、および Storage と HostStorage 複合型を使用して、ホストに関連付けられたストレージを報告します。

GET /ovirt-engine/api/hosts/123/storage

GET /ovirt-engine/api/hosts/123/storage

Copy to Clipboard

Toggle word wrap

<host_storage>
  <storage>
    ...
  </storage>
  <storage>
    ...
  </storage>
  ...
</host_storage>

<host_storage>
  <storage>
    ...
  </storage>
  <storage>
    ...
  </storage>
  ...
</host_storage>

Copy to Clipboard

Toggle word wrap

これは、API の残りの部分で使用されるパターンに従っていません。外側の要素は複数形で、内側の要素は同じ名前ですが単数形です。これは、外側の要素として host_storages を、内側の要素として host_storage を使用するように変更されました。

GET /ovirt-engine/api/hosts/123/storage

GET /ovirt-engine/api/hosts/123/storage

Copy to Clipboard

Toggle word wrap

<host_storages>
  <host_storage>
    ...
  </host_storage>
  <host_storage>
    ...
  </host_storage>
  ...
</host_storage>

<host_storages>
  <host_storage>
    ...
  </host_storage>
  <host_storage>
    ...
  </host_storage>
  ...
</host_storage>

Copy to Clipboard

Toggle word wrap

B.1.35. permissions.clone 要素の削除
リンクのコピー

この要素は実際にはアクセス許可の表現の一部ではありませんが、仮想マシンまたはテンプレートを作成する操作のパラメーターです。

POST /ovirt-engine/api/vms

POST /ovirt-engine/api/vms

Copy to Clipboard

Toggle word wrap

<vm>
  <template id="...">
    <permissions>
      <clone>true</clone>
    </permissions>
  </template>
</action>

<vm>
  <template id="...">
    <permissions>
      <clone>true</clone>
    </permissions>
  </template>
</action>

Copy to Clipboard

Toggle word wrap

POST /ovirt-engine/api/templates

POST /ovirt-engine/api/templates

Copy to Clipboard

Toggle word wrap

<template>
  <vm id="...">
    <permissions>
      <clone>true</clone>
    </permissions>
  </vm>
</template>

<template>
  <vm id="...">
    <permissions>
      <clone>true</clone>
    </permissions>
  </vm>
</template>

Copy to Clipboard

Toggle word wrap

これは削除され、新しい clone_permissions クエリーパラメーターに置き換えられました。

POST /ovirt-engine/api/vms?clone_permissions=true

POST /ovirt-engine/api/vms?clone_permissions=true

Copy to Clipboard

Toggle word wrap

<vm>
  <template id="..."/>
</vm>

<vm>
  <template id="..."/>
</vm>

Copy to Clipboard

Toggle word wrap

POST /ovirt-engine/api/templates?clone_permissions=true

POST /ovirt-engine/api/templates?clone_permissions=true

Copy to Clipboard

Toggle word wrap

<template>
  <vm id="..."/>
</template>

<template>
  <vm id="..."/>
</template>

Copy to Clipboard

Toggle word wrap

B.1.36. 乱数ジェネレーター source 要素の名前の変更
リンクのコピー

乱数ジェネレーターのソースは、その使用を反映した名前の要素でラップされた source 要素のコレクションを使用して報告されていました。たとえば、従来は、クラスターの必要な乱数ジェネレーターソースは以下のように報告されていました。

GET /ovirt-engine/api/clusters/123

GET /ovirt-engine/api/clusters/123

Copy to Clipboard

Toggle word wrap

<cluster>
  ...
  <required_rng_sources>
    <source>random</source>
  </required_rng_sources>
  ...
</cluster>

<cluster>
  ...
  <required_rng_sources>
    <source>random</source>
  </required_rng_sources>
  ...
</cluster>

Copy to Clipboard

Toggle word wrap

また、ホストによってサポートされる乱数ジェネレーターソースは、以下のように報告されていました。

GET /ovirt-engine/api/hosts/123

GET /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

<host>
  ...
  <hardware_information>
    <supported_rng_sources>
      <source>random</source>
    </supported_rng_sources>
  </hardware_information>
  ...
</host>

<host>
  ...
  <hardware_information>
    <supported_rng_sources>
      <source>random</source>
    </supported_rng_sources>
  </hardware_information>
  ...
</host>

Copy to Clipboard

Toggle word wrap

これは、コレクションが複数形で名前でラップされ、要素が単数形で同じ名前でラップされる他の API と一貫していません。これは修正されました。必要な乱数ジェネレーターソースは、以下のように報告されるようになりました。

GET /ovirt-engine/api/clusters/123

GET /ovirt-engine/api/clusters/123

Copy to Clipboard

Toggle word wrap

<cluster>
  <required_rng_sources>
    <required_rng_sources>random</required_rng_source>
  </required_rng_sources>
  ...
</cluster>

<cluster>
  <required_rng_sources>
    <required_rng_sources>random</required_rng_source>
  </required_rng_sources>
  ...
</cluster>

Copy to Clipboard

Toggle word wrap

また、ホストでサポートされる乱数ジェネレーターソースは、以下のように報告されます。

GET /ovirt-engine/api/hosts/123

GET /ovirt-engine/api/hosts/123

Copy to Clipboard

Toggle word wrap

<host>
  ...
  <hardware_information>
    <supported_rng_sources>
      <supported_rng_source>random</supported_rng_source>
    </supported_rng_sources>
  </hardware_information>
  ...
</host>

<host>
  ...
  <hardware_information>
    <supported_rng_sources>
      <supported_rng_source>random</supported_rng_source>
    </supported_rng_sources>
  </hardware_information>
  ...
</host>

Copy to Clipboard

Toggle word wrap

source だけでなく、required_rng_source と supported_rng_source を使用していることに注意してください。

B.1.37. 中間の tag.parent 要素の削除
リンクのコピー

タグとその親タグの間の関係は、中間の parent タグを使用して表されていましたが、これには別の tag 要素が含まれていました。

<tag>
  <name>mytag</name>
  <parent>
    <tag id="..." href="..."/>
  </parent>
</tag>

<tag>
  <name>mytag</name>
  <parent>
    <tag id="..." href="..."/>
  </parent>
</tag>

Copy to Clipboard

Toggle word wrap

この構造体は単純化され、1 つの parent 要素のみが使用されるようになりました。

<tag>
  <name>mytag</name>
  <parent id="..." href="..."/>
</tag>

<tag>
  <name>mytag</name>
  <parent id="..." href="..."/>
</tag>

Copy to Clipboard

Toggle word wrap

B.1.38. スケジューリングの組み込み名としきい値の削除
リンクのコピー

これまで、クラスターのスケジューリングポリシーの仕様は、組み込み名としきい値に基づいていました。たとえば、均等に分散 されたスケジューリングポリシーを使用するクラスターは、以下のように表されていました。

<cluster>
  <name>mycluster</name>
  <scheduling_policy>
    <policy>evenly_distributed</policy>
    <thresholds high="80" duration="120"/>
  </scheduling_policy>
  ...
</cluster>

<cluster>
  <name>mycluster</name>
  <scheduling_policy>
    <policy>evenly_distributed</policy>
    <thresholds high="80" duration="120"/>
  </scheduling_policy>
  ...
</cluster>

Copy to Clipboard

Toggle word wrap

このメカニズムは、スケジュールポリシーを任意の名前とプロパティーで定義できるトップレベルの /schedulingpolicies コレクションに置き換えられました。たとえば、同じスケジューリングポリシーは、最上位コレクションでは次のように表されます。

<scheduling_policy>
  <name>evenly_distributed</name>
  <properties>
    <property>
      <name>CpuOverCommitDurationMinutes</name>
      <value>2</value>
    </property>
    <property>
      <name>HighUtilization</name>
      <value>80</value>
    </property>
  </properties>
</scheduling_policy>

<scheduling_policy>
  <name>evenly_distributed</name>
  <properties>
    <property>
      <name>CpuOverCommitDurationMinutes</name>
      <value>2</value>
    </property>
    <property>
      <name>HighUtilization</name>
      <value>80</value>
    </property>
  </properties>
</scheduling_policy>

Copy to Clipboard

Toggle word wrap

クラスターの表現は、スケジューリングポリシーをその識別子で参照します。

<cluster>
  <name>mycluster</name>
  <scheduling_policy id="..."/>
  ...
</cluster>

<cluster>
  <name>mycluster</name>
  <scheduling_policy id="..."/>
  ...
</cluster>

Copy to Clipboard

Toggle word wrap

後方互換性を維持するために、古い policy 要素および thresholds 要素が保持されました。クラスター内に組み込まれたスケジューリングポリシー表現も保持されました。これらはすべて完全に削除されたため、クラスターを取得、作成、または更新するときにスケジューリングポリシーを参照する唯一の方法は、識別子を使用して既存のポリシーを参照することです。たとえば、クラスターを取得する場合、id (および href) のみが入力されます。

GET /ovirt-engine/api/clusters/123

GET /ovirt-engine/api/clusters/123

Copy to Clipboard

Toggle word wrap

<cluster>
  ...
  <scheduling_policy id="..." href="..."/>
  ...
</cluster>

<cluster>
  ...
  <scheduling_policy id="..." href="..."/>
  ...
</cluster>

Copy to Clipboard

Toggle word wrap

クラスターを作成または更新する場合、id のみが受け入れられます。

B.1.39. bricks.replica_count および bricks.stripe_count の削除
リンクのコピー

これらの要素は、実際にはブリックのコレクションの表現の一部ではなく、ブリックを追加および削除する操作のパラメーターです。これらは削除され、新しい replica_count および strip_count パラメーターに置き換えられました。

POST .../bricks?replica_count=3&stripe_count=2

POST .../bricks?replica_count=3&stripe_count=2

Copy to Clipboard

Toggle word wrap

DELETE .../bricks?replica_count=3

DELETE .../bricks?replica_count=3

Copy to Clipboard

Toggle word wrap

B.1.40. 統計 type プロパティーの名前を kind に変更する
リンクのコピー

統計は、統計の種類 (ゲージ、カウンターなど) を示す type 要素と、値の型 (整数、文字列など) を示す type 属性を使用して表されていました。

<statistic>
  <type>GAUGE</type>
  <values type="INTEGER">
    <value>...</value>
    <value>...</value>
    ...
  </values>
</statistic>

<statistic>
  <type>GAUGE</type>
  <values type="INTEGER">
    <value>...</value>
    <value>...</value>
    ...
  </values>
</statistic>

Copy to Clipboard

Toggle word wrap

両方の 型 概念の使用を避けるために、最初のものが kind に置き換えられ、kind と type の両方が要素になりました。

<statistic>
  <kind>gauge</kind>
  <type>integer</type>
  <values>
    <value>...</value>
    <value>...</value>
    ...
  </values>
</statistic>

<statistic>
  <kind>gauge</kind>
  <type>integer</type>
  <values>
    <value>...</value>
    <value>...</value>
    ...
  </values>
</statistic>

Copy to Clipboard

Toggle word wrap

B.1.41. 複数の vcpu_pin の代わりに複数の vcpu_pins.vcpu_pin を使用する
リンクのコピー

これまで、仮想マシンの仮想から物理への CPU ピニングを指定するには、複数の vcpu_pin 要素を使用する方法を使用していました。

<vm>
  <cpu>
    <cpu_tune>
      <vcpu_pin>...</vcpu_pin>
      <vcpu_pin>...</vcpu_pin>
      ...
    </cpu_tune>
  </cpu>
</vm>

<vm>
  <cpu>
    <cpu_tune>
      <vcpu_pin>...</vcpu_pin>
      <vcpu_pin>...</vcpu_pin>
      ...
    </cpu_tune>
  </cpu>
</vm>

Copy to Clipboard

Toggle word wrap

API の他の部分の一般的な慣例に準拠するために、これはラッパー要素を使用するように変更され、今回の場合は vcpu_pins です。

<vm>
  <cpu>
    <cpu_tune>
      <vcpu_pins>
        <vcpu_pin>...</vcpu_pin>
        <vcpu_pin>...</vcpu_pin>
        ...
      </vcpu_pins>
    </cpu_tune>
  </cpu>
</vm>

<vm>
  <cpu>
    <cpu_tune>
      <vcpu_pins>
        <vcpu_pin>...</vcpu_pin>
        <vcpu_pin>...</vcpu_pin>
        ...
      </vcpu_pins>
    </cpu_tune>
  </cpu>
</vm>

Copy to Clipboard

Toggle word wrap

B.1.42. force パラメーターを使用してデータセンターを強制的に削除する
リンクのコピー

データセンターを削除する操作では、force パラメーターがサポートされています。これを使用するために、DELETE オペレーションはオプションのアクションパラメーターをサポートしていました。

DELETE /ovirt-engine/api/datacenters/123

DELETE /ovirt-engine/api/datacenters/123

Copy to Clipboard

Toggle word wrap

<action>
  <force>true</force>
</action>

<action>
  <force>true</force>
</action>

Copy to Clipboard

Toggle word wrap

このオプションのアクションパラメーターは、オプションのパラメーターに置き換えられました。

DELETE /ovirt-engine/api/datacenters/123?force=true

DELETE /ovirt-engine/api/datacenters/123?force=true

Copy to Clipboard

Toggle word wrap

B.1.43. force パラメーターを使用してホストを強制的に削除する
リンクのコピー

ホストを削除する操作では、force パラメーターがサポートされています。これを使用するために、DELETE オペレーションはオプションのアクションパラメーターをサポートしていました。

DELETE /ovirt-engine/api/host/123

DELETE /ovirt-engine/api/host/123

Copy to Clipboard

Toggle word wrap

<action>
  <force>true</force>
</action>

<action>
  <force>true</force>
</action>

Copy to Clipboard

Toggle word wrap

このオプションのアクションパラメーターは、オプションのパラメーターに置き換えられました。

DELETE /ovirt-engine/api/host/123?force=true

DELETE /ovirt-engine/api/host/123?force=true

Copy to Clipboard

Toggle word wrap

B.1.44. ストレージドメインの強制削除にパラメーターを使用する
リンクのコピー

ストレージドメインを削除する操作は、force、destroy、および host パラメーターをサポートしています。これらのパラメーターは、本体としてストレージドメインの表現を使用して DELETE メソッドに渡されていました。

DELETE /ovirt-engine/api/storagedomains/123

DELETE /ovirt-engine/api/storagedomains/123

Copy to Clipboard

Toggle word wrap

<storage_domain>
  <force>...</force>
  <destroy>...</destroy>
  <host id="...">
    <name>...</name>
  </host>
</storage_domain>

<storage_domain>
  <force>...</force>
  <destroy>...</destroy>
  <host id="...">
    <name>...</name>
  </host>
</storage_domain>

Copy to Clipboard

Toggle word wrap

HTTP DELETE パラメーターに本文が含まれているべきではなく、ストレージドメインの表現にもストレージドメインの属性ではないものを含めず、操作のパラメーターを含める必要があるため、これには問題がありました。

force、delete、および host 属性は同等のパラメーターに置き換えられ、操作では本文を使用できなくなりました。たとえば、force パラメーターを使用してストレージドメインを正しく削除する方法は次のとおりです。

DELETE /ovirt-engine/api/storagedomain/123?host=myhost&force=true

DELETE /ovirt-engine/api/storagedomain/123?host=myhost&force=true

Copy to Clipboard

Toggle word wrap

destroy パラメーターを使用して削除するには以下を実行します。

DELETE /ovirt-engine/api/storagedomain/123?host=myhost&destroy=true

DELETE /ovirt-engine/api/storagedomain/123?host=myhost&destroy=true

Copy to Clipboard

Toggle word wrap

B.1.45. host パラメーターを使用したストレージサーバー接続の削除
リンクのコピー

ストレージサーバー接続を削除する操作は、host パラメーターをサポートします。これを使用するには、オプションのアクションパラメーターをサポートするために使用される DELETE メソッドを使用します。

DELETE /ovirt-engine/api/storageconnections/123

DELETE /ovirt-engine/api/storageconnections/123

Copy to Clipboard

Toggle word wrap

<action>
  <host id="...">
    <name>...</name>
  </host>
</action>

<action>
  <host id="...">
    <name>...</name>
  </host>
</action>

Copy to Clipboard

Toggle word wrap

このオプションのアクションパラメーターは、オプションのパラメーターに置き換えられました。

DELETE /ovirt-engine/api/storageconnections/123?host=myhost

DELETE /ovirt-engine/api/storageconnections/123?host=myhost

Copy to Clipboard

Toggle word wrap

B.1.46. force と storage_domain パラメーターを使用したテンプレートディスクの削除
リンクのコピー

テンプレートディスクを削除する操作では、force および storage_domain パラメーターがサポートされます。このパラメーターを使用するには、オプションのアクションパラメーターのサポートに使用される DELETE メソッドを使用します。

DELETE /ovirt-engine/api/templates/123/disks/456

DELETE /ovirt-engine/api/templates/123/disks/456

Copy to Clipboard

Toggle word wrap

<action>
  <force>...</force>
  <storage_domain id="..."/>
</action>

<action>
  <force>...</force>
  <storage_domain id="..."/>
</action>

Copy to Clipboard

Toggle word wrap

API のバージョン 4 では、この操作は新しい diskattachments コレクションに移動され、要求本文はクエリーパラメーター force および storage_domain に置き換えられました。

DELETE /ovirt-engine/api/templates/123/disksattachments/456?force=true

DELETE /ovirt-engine/api/templates/123/disksattachments/456?force=true

Copy to Clipboard

Toggle word wrap

DELETE /ovirt-engine/api/templates/123/disksattachments/456?storage_domain=123

DELETE /ovirt-engine/api/templates/123/disksattachments/456?storage_domain=123

Copy to Clipboard

Toggle word wrap

B.1.47. VM ディスク API を介してディスクを削除しないでください
リンクのコピー

/vms/123/disks/456 を削除してエンティティーを削除すると、VM とディスクの間の関係が削除されるので、この操作では VM からディスクを切り離す必要があります。この操作では、システムからディスクを完全に削除できなくなり、ユーザーが間違いを犯しやすく、元に戻せない結果が生じていました。ディスクを削除するには、代わりに /disk/456 API を使用します。

DELETE /ovirt-engine/api/disks/456

DELETE /ovirt-engine/api/disks/456

Copy to Clipboard

Toggle word wrap

B.1.48. force クエリーパラメーターを使用して、仮想マシンを強制的に削除する
リンクのコピー

仮想マシンを削除する操作では、force パラメーターがサポートされています。これを使用するには、オプションのアクションパラメーターをサポートするために使用される DELETE メソッドを使用します。

DELETE /ovirt-engine/api/vms/123

DELETE /ovirt-engine/api/vms/123

Copy to Clipboard

Toggle word wrap

<action>
  <force>true</force>
</action>

<action>
  <force>true</force>
</action>

Copy to Clipboard

Toggle word wrap

このオプションのアクションパラメーターは、オプションのクエリーパラメーターに置き換えられました。

DELETE /ovirt-engine/api/vms/123?force=true

DELETE /ovirt-engine/api/vms/123?force=true

Copy to Clipboard

Toggle word wrap

B.1.49. 複数のブリックを削除するには、DELETE の代わりに POST を使用する
リンクのコピー

複数の Gluster ブリックを削除する操作は、DELETE メソッドを使用して実装され、ブリックのリストをリクエストの本文として渡します。

DELETE /ovirt-engine/api/clusters/123/glustervolumes/456/bricks

DELETE /ovirt-engine/api/clusters/123/glustervolumes/456/bricks

Copy to Clipboard

Toggle word wrap

<bricks>
  <bricks id="..."/>
  <bricks id="..."/>
  ...
</bricks>

<bricks>
  <bricks id="..."/>
  <bricks id="..."/>
  ...
</bricks>

Copy to Clipboard

Toggle word wrap

DELETE メソッドには本体がないため、これは問題であるため、POST メソッドを使用する新しい 削除 アクションに置き換えられました。

POST /ovirt-engine/api/clusters/123/glustervolumes/456/bricks/remove

POST /ovirt-engine/api/clusters/123/glustervolumes/456/bricks/remove

Copy to Clipboard

Toggle word wrap

<bricks>
  <bricks id="..."/>
  <bricks id="..."/>
  ...
</bricks>

<bricks>
  <bricks id="..."/>
  <bricks id="..."/>
  ...
</bricks>

Copy to Clipboard

Toggle word wrap

B.1.50. Scheduling_policy.policy 要素の削除
リンクのコピー

この要素は後方互換性のために保持されていました。代わりに Scheduling_policy.name を使用してください。

POST /ovirt-engine/api/schedulingpolicies

POST /ovirt-engine/api/schedulingpolicies

Copy to Clipboard

Toggle word wrap

<scheduling_policy>
  ...
  <name>policy_name</name>
  ...
</scheduling_policy>

<scheduling_policy>
  ...
  <name>policy_name</name>
  ...
</scheduling_policy>

Copy to Clipboard

Toggle word wrap

PUT /ovirt-engine/api/schedulingpolicies/123

PUT /ovirt-engine/api/schedulingpolicies/123

Copy to Clipboard

Toggle word wrap

<scheduling_policy>
  ...
  <name>policy_name</name>
  ...
</scheduling_policy>

<scheduling_policy>
  ...
  <name>policy_name</name>
  ...
</scheduling_policy>

Copy to Clipboard

Toggle word wrap

B.1.51. snapshot.snapshot_type の追加
リンクのコピー

Enum は徐々に API に導入されています。これまで文字列だった一部のフィールドは、適切な列挙型に置き換えられます。そのようなフィールドの 1 つが vm.type です。ただし、このフィールドはスナップショットによって継承され、スナップショットタイプは vm タイプとは異なります。そのため、新しいフィールド (snapshot.snapshot_type) がスナップショットエンティティーに追加されました。

<snapshot>
  ...
  <snapshot_type>regular|active|stateless|preview</snapshot_type>
  ...
</snapshot>

<snapshot>
  ...
  <snapshot_type>regular|active|stateless|preview</snapshot_type>
  ...
</snapshot>

Copy to Clipboard

Toggle word wrap

B.1.52. VM からの move アクションの削除
リンクのコピー

VM エンティティーの非推奨の move アクションは削除されました。代わりに、個々のディスクを移動できます。

B.1.53. reported_configurations.in_sync を network_attachment に移動する
リンクのコピー

API のバージョン 3 では、XML スキーマタイプ ReportedConfigurations に in_sync プロパティーがありました。

<network_attachment>
  <reported_configurations>
    <in_sync>true</in_sync>
    <reported_configuration>
      ...
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

<network_attachment>
  <reported_configurations>
    <in_sync>true</in_sync>
    <reported_configuration>
      ...
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

Copy to Clipboard

Toggle word wrap

リストタイプ (報告された設定のリスト) には属性を指定できないので、API のバージョン 4 で使用される仕様メカニズムでは、これを表現することはできません。それを表現できるようにするために、属性は in_sync を囲む network_attachment に移動されました。

<network_attachment>
  <in_sync>true</in_sync>
  <reported_configurations>
    <reported_configuration>
      ...
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

<network_attachment>
  <in_sync>true</in_sync>
  <reported_configurations>
    <reported_configuration>
      ...
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

Copy to Clipboard

Toggle word wrap

B.1.54. capabilities を clusterlevels に置き換える
リンクのコピー

最上位の capabilities コレクションは、新しい clusterlevels コレクションに置き換えられました。この新しいコレクションには、各クラスターレベルで使用可能な CPU タイプのリストなど、モデルでは使用できない情報が含まれます。

GET /ovirt-engine/api/clusterlevels

GET /ovirt-engine/api/clusterlevels

Copy to Clipboard

Toggle word wrap

これにより、システムでサポートされている全クラスターレベルの詳細を含め、ClusterLevel オブジェクトのリストが返されます。

<cluster_levels>
  <cluster_level id="3.6" href="/clusterlevels/3.6">
    <cpu_types>
      <cpu_type>
        <name>Intel Nehalem Family</name>
        <level>2</level>
        <architecture>x86_64</architecture>
      </cpu_type>
      ...
    </cpu_types>
    ...
  </cluster_level>
</cluster_levels>

<cluster_levels>
  <cluster_level id="3.6" href="/clusterlevels/3.6">
    <cpu_types>
      <cpu_type>
        <name>Intel Nehalem Family</name>
        <level>2</level>
        <architecture>x86_64</architecture>
      </cpu_type>
      ...
    </cpu_types>
    ...
  </cluster_level>
</cluster_levels>

Copy to Clipboard

Toggle word wrap

特定の各クラスターレベルには、バージョン自体で識別される独自のサブリソースがあります。

GET /ovirt-engine/api/clusterlevels/3.6

GET /ovirt-engine/api/clusterlevels/3.6

Copy to Clipboard

Toggle word wrap

これにより、そのバージョンの詳細が返されます。

<cluster_level id="3.6" href="/clusterlevels/3.6">
  <cpu_types>
    <cpu_type>
      <name>Intel Nehalem Family</name>
      <level>2</level>
      <architecture>x86_64</architecture>
    </cpu_type>
    ...
  </cpu_types>
  ...
</cluster_level>

<cluster_level id="3.6" href="/clusterlevels/3.6">
  <cpu_types>
    <cpu_type>
      <name>Intel Nehalem Family</name>
      <level>2</level>
      <architecture>x86_64</architecture>
    </cpu_type>
    ...
  </cpu_types>
  ...
</cluster_level>

Copy to Clipboard

Toggle word wrap

B.1.55. disks を diskattachments に置き換える
リンクのコピー

バージョン 3 の API 仮想マシンとテンプレートには、接続されているディスクのすべての情報を含む disks コレクションがありました。API のバージョン 4 では、これらの disks コレクションは削除され、新しい diskattachments コレクションに置き換えられました。このコレクションには、ディスクへの参照と、ディスクとディスクが接続されている仮想マシンまたはテンプレートとの関係に固有の属性のみ (interface と bootable) が含まれます。

たとえば、仮想マシンに接続されているディスクを見つけるには、以下のようなリクエストを送信します。

GET /ovirt-engine/api/vms/123/diskattachments

GET /ovirt-engine/api/vms/123/diskattachments

Copy to Clipboard

Toggle word wrap

以下のような応答が返されます。

<disk_attachments>
  <disk_attachment href="/vms/123/diskattachments/456" id="456">
    <bootable>false</bootable>
    <interface>virtio</interface>
    <disk href="/disks/456" id="456"/>
    <vm href="/vms/123" id="123"/>
  </disk_attachment>
  ...
<disk_attachments>

<disk_attachments>
  <disk_attachment href="/vms/123/diskattachments/456" id="456">
    <bootable>false</bootable>
    <interface>virtio</interface>
    <disk href="/disks/456" id="456"/>
    <vm href="/vms/123" id="123"/>
  </disk_attachment>
  ...
<disk_attachments>

Copy to Clipboard

Toggle word wrap

ディスクの残りの詳細を見つけるには、提供されたリンクを参照してください。

仮想マシンまたはテンプレートにディスクを追加すると、新しい disk_attachment 要素も使用されます。リクエストが以下のようになります。

POST /ovirt-engine/api/vms/123/diskattachments

POST /ovirt-engine/api/vms/123/diskattachments

Copy to Clipboard

Toggle word wrap

ディスクが存在せず、作成する場合は、次の本文を使用します。

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>1048576</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>1048576</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

または、ディスクがすでに存在し、ディスクを仮想マシンにアタッチするだけの場合は、次の本文を使用します。

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <disk id="456"/>
</disk_attachment>

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <disk id="456"/>
</disk_attachment>

Copy to Clipboard

Toggle word wrap

vm.disks および template.disks 属性には、すべての用途に対して disk_attachments があることを考慮してください。たとえば、テンプレートを作成するとき、テンプレートのディスクを作成するストレージドメインを指定するために vm.disks 要素が使用されていました。この使用方法も vm.disk_attachments に置き換えられたため、特定のストレージドメインにディスクを含むテンプレートを作成するリクエストは次のようになります。

<template>
  <name>mytemplate</name>
  <vm id="123">
    <disk_attachments>
      <disk_attachment>
        <disk id="456">
          <storage_domains>
            <storage_domain id="789"/>
          </storage_domains>
        </disk>
      </disk_attachment>
      ...
    </disk_attachments>
  </vm>
</template>

<template>
  <name>mytemplate</name>
  <vm id="123">
    <disk_attachments>
      <disk_attachment>
        <disk id="456">
          <storage_domains>
            <storage_domain id="789"/>
          </storage_domains>
        </disk>
      </disk_attachment>
      ...
    </disk_attachments>
  </vm>
</template>

Copy to Clipboard

Toggle word wrap

B.1.56. iscsi_targets 要素を使用して、未登録のストレージを検出する
リンクのコピー

API のバージョン 3 では、未登録のストレージドメインを検出する操作は、複数の iscsi_target を使用して iSCSI ターゲットの一覧を受信していました。

POST /ovirt-engine/api/hosts/123/unregisteredstoragedomaindiscover

POST /ovirt-engine/api/hosts/123/unregisteredstoragedomaindiscover

Copy to Clipboard

Toggle word wrap

<action>
  <iscsi>
    <address>myiscsiserver</address>
  </iscsi>
  <iscsi_target>iqn.2016-07.com.example:mytarget1</iscsi_target>
  <iscsi_target>iqn.2016-07.com.example:mytarget2</iscsi_target>
</action>

<action>
  <iscsi>
    <address>myiscsiserver</address>
  </iscsi>
  <iscsi_target>iqn.2016-07.com.example:mytarget1</iscsi_target>
  <iscsi_target>iqn.2016-07.com.example:mytarget2</iscsi_target>
</action>

Copy to Clipboard

Toggle word wrap

API のバージョン 4 では、この場合の iscsi_target のようなすべての繰り返し要素は、別の要素 (この場合は iscsi_targets) でラップされます。したがって、同じリクエストは次のようになります。

POST /ovirt-engine/api/hosts/123/unregisteredstoragedomaindiscover

POST /ovirt-engine/api/hosts/123/unregisteredstoragedomaindiscover

Copy to Clipboard

Toggle word wrap

<action>
  <iscsi>
    <address>myiscsiserver</address>
  </iscsi>
  <iscsi_targets>
    <iscsi_target>iqn.2016-07.com.example:mytarget1</iscsi_target>
    <iscsi_target>iqn.2016-07.com.example:mytarget2</iscsi_target>
  </iscsi_targets>
</action>

<action>
  <iscsi>
    <address>myiscsiserver</address>
  </iscsi>
  <iscsi_targets>
    <iscsi_target>iqn.2016-07.com.example:mytarget1</iscsi_target>
    <iscsi_target>iqn.2016-07.com.example:mytarget2</iscsi_target>
  </iscsi_targets>
</action>

Copy to Clipboard

Toggle word wrap

B.2. エンジンバージョン 4.5 の変更点
リンクのコピー

B.2.1. Openstack Volume (Cinder) 統合は Managed Block Storage に置き換えられる
リンクのコピー

付録C 法的通知
リンクのコピー

Licensed under the (Creative Commons Attribution–ShareAlike 4.0 International License).Derived from documentation for the (oVirt Project).If you distribute this document or an adaptation of it, you must provide the URL for the original version.

Modified versions must remove all Red Hat trademarks.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent.Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission.We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

REST API ガイド

Red Hat Virtualization REST アプリケーションプログラミングインターフェイスの使用

Red Hat Virtualization Documentation Team

第1章 はじめにリンクのコピーリンクがクリップボードにコピーされました!

1.1. Representational State Transferリンクのコピーリンクがクリップボードにコピーされました!

1.1.1. API の前提条件リンクのコピーリンクがクリップボードにコピーされました!

第2章 認証とセキュリティーリンクのコピーリンクがクリップボードにコピーされました!

2.1. TLS/SSL 証明書リンクのコピーリンクがクリップボードにコピーされました!

2.1.1. CA 証明書の取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.2. クライアントへの証明書のインポートリンクのコピーリンクがクリップボードにコピーされました!

2.2. 認証リンクのコピーリンクがクリップボードにコピーされました!

2.2.1. OAuth 認証リンクのコピーリンクがクリップボードにコピーされました!

2.2.2. Basic 認証リンクのコピーリンクがクリップボードにコピーされました!

2.2.3. 認証セッションリンクのコピーリンクがクリップボードにコピーされました!

2.2.3.1. 認証されたセッションの要求リンクのコピーリンクがクリップボードにコピーされました!

第3章 一般的な概念リンクのコピーリンクがクリップボードにコピーされました!

3.1. タイプリンクのコピーリンクがクリップボードにコピーされました!

3.2. 特定タイプリンクのコピーリンクがクリップボードにコピーされました!

3.3. オブジェクトリンクのコピーリンクがクリップボードにコピーされました!

3.4. コレクションリンクのコピーリンクがクリップボードにコピーされました!

3.5. 表現リンクのコピーリンクがクリップボードにコピーされました!

3.5.1. XML 表現リンクのコピーリンクがクリップボードにコピーされました!

3.5.2. JSON 表現リンクのコピーリンクがクリップボードにコピーされました!

3.6. サービスリンクのコピーリンクがクリップボードにコピーされました!

3.7. 検索リンクのコピーリンクがクリップボードにコピーされました!

3.7.1. 最大結果パラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.7.2. ケースの機密性リンクのコピーリンクがクリップボードにコピーされました!

3.7.3. 検索構文リンクのコピーリンクがクリップボードにコピーされました!

3.7.4. ワイルドカードリンクのコピーリンクがクリップボードにコピーされました!

3.7.5. ページネーションリンクのコピーリンクがクリップボードにコピーされました!

3.8. リンクの移動リンクのコピーリンクがクリップボードにコピーされました!

3.9. パーミッションリンクのコピーリンクがクリップボードにコピーされました!

3.10. エラーの処理リンクのコピーリンクがクリップボードにコピーされました!

第4章 クイックスタートの例リンクのコピーリンクがクリップボードにコピーされました!

4.1. API エントリーポイントへのアクセスリンクのコピーリンクがクリップボードにコピーされました!

4.2. データセンターのリスト表示リンクのコピーリンクがクリップボードにコピーされました!

4.3. ホストクラスターのリスト表示リンクのコピーリンクがクリップボードにコピーされました!

4.4. 論理ネットワークのリスト表示リンクのコピーリンクがクリップボードにコピーされました!

4.5. ホストをリスト表示します。リンクのコピーリンクがクリップボードにコピーされました!

4.6. NFS データストレージの作成リンクのコピーリンクがクリップボードにコピーされました!

4.7. NFS ISO ストレージの作成リンクのコピーリンクがクリップボードにコピーされました!

4.8. データセンターへのストレージドメインの割り当てリンクのコピーリンクがクリップボードにコピーされました!

4.9. 仮想マシンの作成リンクのコピーリンクがクリップボードにコピーされました!

4.10. 仮想マシン NIC の作成リンクのコピーリンクがクリップボードにコピーされました!

4.11. 仮想マシンディスクの作成リンクのコピーリンクがクリップボードにコピーされました!

4.12. ISO イメージの仮想マシンへのアタッチリンクのコピーリンクがクリップボードにコピーされました!

4.13. 仮想マシンの起動リンクのコピーリンクがクリップボードにコピーされました!

第5章 要求リンクのコピーリンクがクリップボードにコピーされました!

第6章 サービスリンクのコピーリンクがクリップボードにコピーされました!

6.1. AffinityGroupリンクのコピーリンクがクリップボードにコピーされました!

6.1.1. get GETリンクのコピーリンクがクリップボードにコピーされました!

6.1.1.1. followリンクのコピーリンクがクリップボードにコピーされました!

6.1.2. remove DELETEリンクのコピーリンクがクリップボードにコピーされました!

6.1.3. update PUTリンクのコピーリンクがクリップボードにコピーされました!

6.2. AffinityGroupHostリンクのコピーリンクがクリップボードにコピーされました!

6.2.1. remove DELETEリンクのコピーリンクがクリップボードにコピーされました!

6.3. AffinityGroupHostLabelリンクのコピーリンクがクリップボードにコピーされました!

6.3.1. remove DELETEリンクのコピーリンクがクリップボードにコピーされました!

6.4. AffinityGroupHostLabelsリンクのコピーリンクがクリップボードにコピーされました!

6.4.1. add POSTリンクのコピーリンクがクリップボードにコピーされました!

6.4.2. list GETリンクのコピーリンクがクリップボードにコピーされました!

6.4.2.1. followリンクのコピーリンクがクリップボードにコピーされました!

6.4.2.2. maxリンクのコピーリンクがクリップボードにコピーされました!

6.5. AffinityGroupHostsリンクのコピーリンクがクリップボードにコピーされました!

6.5.1. add POSTリンクのコピーリンクがクリップボードにコピーされました!

6.5.2. list GETリンクのコピーリンクがクリップボードにコピーされました!

6.5.2.1. followリンクのコピーリンクがクリップボードにコピーされました!

6.5.2.2. maxリンクのコピーリンクがクリップボードにコピーされました!

6.6. AffinityGroupVmリンクのコピーリンクがクリップボードにコピーされました!

6.6.1. remove DELETEリンクのコピーリンクがクリップボードにコピーされました!

6.7. AffinityGroupVmLabelリンクのコピーリンクがクリップボードにコピーされました!

6.7.1. remove DELETEリンクのコピーリンクがクリップボードにコピーされました!

6.8. AffinityGroupVmLabelsリンクのコピーリンクがクリップボードにコピーされました!

6.8.1. add POSTリンクのコピーリンクがクリップボードにコピーされました!

6.8.2. list GETリンクのコピーリンクがクリップボードにコピーされました!

6.8.2.1. followリンクのコピーリンクがクリップボードにコピーされました!

6.8.2.2. maxリンクのコピーリンクがクリップボードにコピーされました!

6.9. AffinityGroupVmsリンクのコピーリンクがクリップボードにコピーされました!

6.9.1. add POSTリンクのコピーリンクがクリップボードにコピーされました!

6.9.2. list GETリンクのコピーリンクがクリップボードにコピーされました!

第1章はじめに
リンクのコピー

1.1. Representational State Transfer
リンクのコピー

1.1.1. API の前提条件
リンクのコピー

第2章認証とセキュリティー
リンクのコピー

2.1. TLS/SSL 証明書
リンクのコピー

2.1.1. CA 証明書の取得
リンクのコピー

2.1.2. クライアントへの証明書のインポート
リンクのコピー

2.2. 認証
リンクのコピー

2.2.1. OAuth 認証
リンクのコピー

2.2.2. Basic 認証
リンクのコピー

2.2.3. 認証セッション
リンクのコピー

2.2.3.1. 認証されたセッションの要求
リンクのコピー

第3章一般的な概念
リンクのコピー

3.1. タイプ
リンクのコピー

3.2. 特定タイプ
リンクのコピー

3.3. オブジェクト
リンクのコピー

3.4. コレクション
リンクのコピー

3.5. 表現
リンクのコピー

3.5.1. XML 表現
リンクのコピー

3.5.2. JSON 表現
リンクのコピー

3.6. サービス
リンクのコピー

3.7. 検索
リンクのコピー

3.7.1. 最大結果パラメーター
リンクのコピー

3.7.2. ケースの機密性
リンクのコピー

3.7.3. 検索構文
リンクのコピー

3.7.4. ワイルドカード
リンクのコピー

3.7.5. ページネーション
リンクのコピー

3.8. リンクの移動
リンクのコピー

3.9. パーミッション
リンクのコピー

3.10. エラーの処理
リンクのコピー

第4章クイックスタートの例
リンクのコピー

4.1. API エントリーポイントへのアクセス
リンクのコピー

4.2. データセンターのリスト表示
リンクのコピー

4.3. ホストクラスターのリスト表示
リンクのコピー

4.4. 論理ネットワークのリスト表示
リンクのコピー

4.5. ホストをリスト表示します。
リンクのコピー

4.6. NFS データストレージの作成
リンクのコピー

4.7. NFS ISO ストレージの作成
リンクのコピー

4.8. データセンターへのストレージドメインの割り当て
リンクのコピー

4.9. 仮想マシンの作成
リンクのコピー

4.10. 仮想マシン NIC の作成
リンクのコピー

4.11. 仮想マシンディスクの作成
リンクのコピー

4.12. ISO イメージの仮想マシンへのアタッチ
リンクのコピー

4.13. 仮想マシンの起動
リンクのコピー

第5章要求
リンクのコピー

第6章サービス
リンクのコピー

6.1. AffinityGroup
リンクのコピー

6.1.1. get GET
リンクのコピー

6.1.1.1. follow
リンクのコピー

6.1.2. remove DELETE
リンクのコピー

6.1.3. update PUT
リンクのコピー

6.2. AffinityGroupHost
リンクのコピー

6.2.1. remove DELETE
リンクのコピー

6.3. AffinityGroupHostLabel
リンクのコピー

6.3.1. remove DELETE
リンクのコピー

6.4. AffinityGroupHostLabels
リンクのコピー

6.4.1. add POST
リンクのコピー

6.4.2. list GET
リンクのコピー

6.4.2.1. follow
リンクのコピー

6.4.2.2. max
リンクのコピー

6.5. AffinityGroupHosts
リンクのコピー

6.5.1. add POST
リンクのコピー

6.5.2. list GET
リンクのコピー

6.5.2.1. follow
リンクのコピー

6.5.2.2. max
リンクのコピー

6.6. AffinityGroupVm
リンクのコピー

6.6.1. remove DELETE
リンクのコピー

6.7. AffinityGroupVmLabel
リンクのコピー

6.7.1. remove DELETE
リンクのコピー

6.8. AffinityGroupVmLabels
リンクのコピー

6.8.1. add POST
リンクのコピー

6.8.2. list GET
リンクのコピー

6.8.2.1. follow
リンクのコピー

6.8.2.2. max
リンクのコピー

6.9. AffinityGroupVms
リンクのコピー

6.9.1. add POST
リンクのコピー

6.9.2. list GET
リンクのコピー

6.9.2.1. follow
リンクのコピー

6.9.2.2. max
リンクのコピー

6.10. AffinityGroups
リンクのコピー