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 '

# 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 '

# 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 '

# 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 '

# 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 '

# 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 '

# 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 '

# 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 '

# 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 '

# 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

$ 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:
Find the host:
Find the service that manages the host:
Configure the network adding a bond with two slaves and attaching it to a
network with an static IP address:
After modifying the network configuration it is very important to make it
persistent:

# 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`	新しいクォータを作成します。

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
リンクのコピー