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

REST API ガイド

Red Hat Virtualization 4.0

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

概要

本ガイドでは、Red Hat Virtualization Manager Representational State Transfer Application Programming Interface について説明します。
このガイドは、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.2. API の前提条件
リンクのコピー

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

  • API を含む Red Hat Virtualization Manager のネットワークインストール。

  • API サーバーから HTTP 要求を開始および受信するクライアントまたはプログラミングライブラリー。以下に例を示します。

  • HTTP (Hypertext Transfer Protocol) の知識 (REST API の対話に使用されるプロトコル)。Internet Engineering Task Force (IETF) は、http://www.ietf.org/rfc/rfc2616.txt でハイパーテキスト転送プロトコルを説明する Request for Comments (RFC) を提供しています。
  • API がリソース表現の構築に使用する Extensible Markup Language(XML) または JavaScript Object Notation(JSON) の知識。W3C は、http://www.w3.org/TR/xml で XML の完全な仕様を提供します。ECMA International は、http://www.ecma-international.org で JSON で無料公開を提供します。

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

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

Red Hat Virtualization API には Hypertext Transfer Protocol Secure (HTTPS) が必要です。 [1] SDK や CLI コンポーネントなどのクライアントソフトウェアとのセキュアな対話これには、サーバーが使用する CA 証明書を取得して、クライアントの証明書ストアにインポートする必要があります。

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

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

方法 1

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

$ 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-----
Copy to Clipboard Toggle word wrap

------BEGIN CERTIFICATE----- と -----END CERTIFICATE----- のマークの間のテキストは、サーバーで提示された証明書が表示されます。最初のものはサーバー自体の証明書で、最後の証明書は CA の証明書です。これらのマークを含む CA 証明書を ca.crt ファイルにコピーします。結果は以下のようになります。 

-----BEGIN CERTIFICATE-----
MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
Pkyg1rQHR6ebGQ==
-----END CERTIFICATE-----
Copy to Clipboard Toggle word wrap
重要

これは、サーバーが使用する CA 証明書を取得する最も信頼性の高い方法です。ここで説明されている残りの方法はほとんどの場合に機能しますが、サーバーの管理者が手動で置き換えられた場合は、正しい CA 証明書は取得されません。

方法 2

上記の openssl s_client メソッドを使用できない場合は、コマンドラインツールを使用して 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'
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'
Copy to Clipboard Toggle word wrap
方法 3

Web ブラウザーを使用して、配置されている証明書に移動します。 

https://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA
Copy to Clipboard Toggle word wrap

選択したブラウザーに応じて、証明書はブラウザーのキーストアにダウンロードまたはインポートします。

  1. ブラウザーにより証明書がダウンロードされた場合 には、ファイルを ca.crt として保存します。
  2. ブラウザーにより証明書がインポートされた場合 には、ブラウザーの認定オプションから証明書をエクスポートし、ca.crt として保存します。
方法 4

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

  1. Red Hat Virtualization Manager マシンに root としてログインします。

  2. Java keytool 管理ユーティリティーを使用して、トラストストアから証明書をエクスポートします。 

    # keytool \
-keystore /etc/pki/ovirt-engine/.truststore \
-storepass mypass \
-exportcert \
-alias cacert \
-rfc \
-file ca.crt
    Copy to Clipboard Toggle word wrap

    これにより、ca.crt という名前の証明書ファイルが作成されます。

  3. scp コマンドを使用して、証明書をクライアントマシンにコピーします。 

    $ 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 の セクション 4.3 で説明されているように 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
Copy to Clipboard Toggle word wrap

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

Expand
表2.1 OAuth トークン要求パラメーター
Name値

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
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": "...",
  ...
}
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=
Copy to Clipboard Toggle word wrap

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

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 認証を使用して [2] 認証情報をエンコードします。要求に適切な Authorization ヘッダーが含まれていない場合には、サーバーは 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

Domain

internal

Password

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
Copy to Clipboard Toggle word wrap
重要

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

重要

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

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

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

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

  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
...
    Copy to Clipboard Toggle word wrap

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

    Set-Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK; Path=/ovirt-engine/api; Secure
    Copy to Clipboard Toggle word wrap

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

  2. 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
...
    Copy to Clipboard Toggle word wrap

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

    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

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

[1] HTTPS は、RFC 2818 HTTP over TLS で説明されています。

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

本章では、基本的な Red Hat Virtualization 環境を設定し、仮想マシンを作成する REST API の機能を示す例を紹介します。この例では、標準の前提条件に加えて、以下が必要です。

  • ネットワークされ設定された Red Hat Virtualization インストール。
  • インストールする仮想マシンオペレーティングシステムを含む ISO ファイル。本章では、インストール ISO の例に CentOS 7 を使用します。
  • 選択したオペレーティングシステムの ISO ファイルをアップロードする Red Hat Virtualization の engine-iso-uploader ツール。

この例では、curl を使用してクライアントアプリケーションでの API 要求を示しています。HTTP リクエストが可能なすべてのアプリケーションは curl を置き換えることができることに注意してください。

重要

分かりやすくするため、この例では Host および Authorization ヘッダーを省略します。ただし、これらのフィールドは必須であり、Red Hat Virtualization のインストールに固有のデータを必要とします。

重要

すべての curl の例では、ユーザー名に admin@internal、パスワードには mypassword、証明書の場所に /etc/pki/ovirt-engine/ca.pem、ホスト名に myengine.example.com を使用しています。これらは単なる例です。お使いの環境の有効な値に置き換えてください。

注記

Red Hat Virtualization は、各リソースの id 属性に一意の識別子を生成します。この例の識別子コードは、お使いの Red Hat Virtualization 環境の識別子コードとは異なる場合があります。

注記

本セクションの多くの例では、API によって返される結果の属性の一部が省略され、短くしています。参照を使用すると、常に属性の完全なリストを検索できます。たとえば、クラスター タイプの属性の完全なリストを表示する場合は、ここ に進んでください。

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

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

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
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
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>
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
Copy to Clipboard Toggle word wrap

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

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

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

3.2. 例：データセンターの一覧表示
リンクのコピー

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

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

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
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>
Copy to Clipboard Toggle word wrap

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

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

<link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>
Copy to Clipboard Toggle word wrap

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

3.3. 例：ホストクラスターの一覧表示
リンクのコピー

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

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

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
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 Conroe 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"/>
Copy to Clipboard Toggle word wrap

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

3.4. 例：論理ネットワークの一覧表示
リンクのコピー

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

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

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

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
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>
Copy to Clipboard Toggle word wrap

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

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

3.5. 例：ホストの一覧表示
リンクのコピー

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

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
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>
Copy to Clipboard Toggle word wrap

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

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

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

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

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

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

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>
Copy to Clipboard Toggle word wrap

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

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

3.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
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>
Copy to Clipboard Toggle word wrap

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

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

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

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

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

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>
Copy to Clipboard Toggle word wrap

curl コマンドを使用して、同じ要求を行います。 

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

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

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>
Copy to Clipboard Toggle word wrap

curl コマンドを使用して、同じ要求を行います。 

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

3.9. 例：仮想マシンの作成
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap

curl コマンドを使用して、同じ要求を行います。 

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

3.10. 例：仮想マシン NIC の作成
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap

curl コマンドを使用して、同じ要求を行います。 

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

3.11. 例：仮想ディスクの作成
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap

curl コマンドを使用して、同じ要求を行います。 

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

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

3.12. 例：ISO イメージの仮想マシンへの割り当て
リンクのコピー

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

仮想マシンが使用するには、myisos ISO ドメインで ISO イメージが利用可能でなければなりません。Red Hat Virtualization は、正しいユーザーパーミッションで ISO イメージが適切なディレクトリーパスにアップロードされるように uploader ツールを提供します。

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

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
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>
Copy to Clipboard Toggle word wrap

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

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

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>
Copy to Clipboard Toggle word wrap

curl コマンドを使用して、同じ要求を行います。 

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

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

3.13. 例：仮想マシンの起動
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap

curl コマンドを使用して、同じ要求を行います。 

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

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

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

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

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

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

5.1. AffinityGroup
リンクのコピー

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

Expand
表5.1 メソッドの概要
Name概要

get

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

remove

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

update

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

5.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>
Copy to Clipboard Toggle word wrap
Expand
表5.2 パラメーターの概要
Nameタイプ方向概要

group

AffinityGroup

Out

アフィニティーグループ。

5.1.2. remove DELETE
リンクのコピー

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

DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456
Copy to Clipboard Toggle word wrap
Expand
表5.3 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.1.3. update PUT
リンクのコピー

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

Expand
表5.4 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

group

AffinityGroup

In/Out

アフィニティーグループ。

5.2. AffinityGroupVm
リンクのコピー

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

Expand
表5.5 メソッドの概要
Name概要

remove

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

5.2.1. remove DELETE
リンクのコピー

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

Expand
表5.6 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.3. AffinityGroupVms
リンクのコピー

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

Expand
表5.7 メソッドの概要
Name概要

add

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

list

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

5.3.1. add POST
リンクのコピー

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

たとえば、仮想マシン 000-000 をアフィニティーグループ 123-456 に追加するには、以下に要求を送信します。 

POST /ovirt-engine/api/clusters/000-000/affinitygroups/123-456/vms
Copy to Clipboard Toggle word wrap

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

<vm id="000-000"/>
Copy to Clipboard Toggle word wrap
Expand
表5.8 パラメーターの概要
Nameタイプ方向概要

vm

Vm

In/Out

 

5.3.2. list GET
リンクのコピー

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

Expand
表5.9 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す仮想マシンの最大数を設定します。

vms

Vm[]

Out

 
5.3.2.1. max
リンクのコピー

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

5.4. AffinityGroups
リンクのコピー

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

Expand
表5.10 メソッドの概要
Name概要

add

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

list

既存のアフィニティーグループを一覧表示します。

5.4.1. add POST
リンクのコピー

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

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

POST /ovirt-engine/api/clusters/000-000/affinitygroups
Copy to Clipboard Toggle word wrap

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

<affinity_group>
  <name>AF_GROUP_001</name>
  <positive>true</positive>
  <enforcing>true</enforcing>
</affinity_group>
Copy to Clipboard Toggle word wrap
Expand
表5.11 パラメーターの概要
Nameタイプ方向概要

group

AffinityGroup

In/Out

作成するアフィニティーグループオブジェクト。

5.4.2. list GET
リンクのコピー

既存のアフィニティーグループを一覧表示します。

Expand
表5.12 パラメーターの概要
Nameタイプ方向概要

groups

AffinityGroup[]

Out

既存のアフィニティーグループの一覧。

max

Integer

In

返すアフィニティーグループの最大数を設定します。

5.4.2.1. max
リンクのコピー

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

5.5. AffinityLabel
リンクのコピー

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

Expand
表5.13 メソッドの概要
Name概要

get

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

remove

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

update

ラベルを更新します。

5.5.1. get GET
リンクのコピー

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

Expand
表5.14 パラメーターの概要
Nameタイプ方向概要

ラベル

AffinityLabel

Out

 

5.5.2. remove DELETE
リンクのコピー

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

5.5.3. update PUT
リンクのコピー

ラベルを更新します。

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

Expand
表5.15 パラメーターの概要
Nameタイプ方向概要

ラベル

AffinityLabel

In/Out

 

5.6. AffinityLabelHost
リンクのコピー

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

Expand
表5.16 メソッドの概要
Name概要

get

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

remove

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

5.6.1. get GET
リンクのコピー

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

Expand
表5.17 パラメーターの概要
Nameタイプ方向概要

host

ホスト

Out

 

5.6.2. remove DELETE
リンクのコピー

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

5.7. AffinityLabelHosts
リンクのコピー

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

Expand
表5.18 メソッドの概要
Name概要

add

Add a label to a host.

list

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

5.7.1. add POST
リンクのコピー

Add a label to a host.

Expand
表5.19 パラメーターの概要
Nameタイプ方向概要

host

ホスト

In/Out

 

5.7.2. list GET
リンクのコピー

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

Expand
表5.20 パラメーターの概要
Nameタイプ方向概要

hosts

Host[]

Out

 

5.8. AffinityLabelVm
リンクのコピー

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

Expand
表5.21 メソッドの概要
Name概要

get

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

remove

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

5.8.1. get GET
リンクのコピー

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

Expand
表5.22 パラメーターの概要
Nameタイプ方向概要

vm

Vm

Out

 

5.8.2. remove DELETE
リンクのコピー

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

5.9. AffinityLabelVms
リンクのコピー

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

Expand
表5.23 メソッドの概要
Name概要

add

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

list

ラベルの付いたすべての vms を一覧表示します。

5.9.1. add POST
リンクのコピー

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

Expand
表5.24 パラメーターの概要
Nameタイプ方向概要

vm

Vm

In/Out

 

5.9.2. list GET
リンクのコピー

ラベルの付いたすべての vms を一覧表示します。

Expand
表5.25 パラメーターの概要
Nameタイプ方向概要

vms

Vm[]

Out

 

5.10. AffinityLabels
リンクのコピー

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

Expand
表5.26 メソッドの概要
Name概要

add

新しいラベルを作成します。

list

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

5.10.1. add POST
リンクのコピー

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

Expand
表5.27 パラメーターの概要
Nameタイプ方向概要

ラベル

AffinityLabel

In/Out

 

5.10.2. list GET
リンクのコピー

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

Expand
表5.28 パラメーターの概要
Nameタイプ方向概要

labels

AffinityLabel[]

Out

 

max

Integer

In

返すラベルの最大数を設定します。

5.10.2.1. max
リンクのコピー

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

5.11. AssignedAffinityLabel
リンクのコピー

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

Expand
表5.29 メソッドの概要
Name概要

get

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

remove

エンティティーからラベルを削除します。

5.11.1. get GET
リンクのコピー

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

Expand
表5.30 パラメーターの概要
Nameタイプ方向概要

ラベル

AffinityLabel

Out

 

5.11.2. remove DELETE
リンクのコピー

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

5.12. AssignedAffinityLabels
リンクのコピー

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

Expand
表5.31 メソッドの概要
Name概要

add

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

list

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

5.12.1. add POST
リンクのコピー

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

Expand
表5.32 パラメーターの概要
Nameタイプ方向概要

ラベル

AffinityLabel

In/Out

 

5.12.2. list GET
リンクのコピー

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

Expand
表5.33 パラメーターの概要
Nameタイプ方向概要

label

AffinityLabel[]

Out

 

5.13. AssignedCpuProfile
リンクのコピー

Expand
表5.34 メソッドの概要
Name概要

get

 

remove

 

5.13.1. get GET
リンクのコピー

Expand
表5.35 パラメーターの概要
Nameタイプ方向概要

profile

CpuProfile

Out

 

5.13.2. remove DELETE
リンクのコピー

Expand
表5.36 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.14. AssignedCpuProfiles
リンクのコピー

Expand
表5.37 メソッドの概要
Name概要

add

 

list

 

5.14.1. add POST
リンクのコピー

Expand
表5.38 パラメーターの概要
Nameタイプ方向概要

profile

CpuProfile

In/Out

 

5.14.2. list GET
リンクのコピー

Expand
表5.39 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロファイルの最大数を設定します。

profiles

CpuProfile[]

Out

 
5.14.2.1. max
リンクのコピー

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

5.15. AssignedDiskProfile
リンクのコピー

Expand
表5.40 メソッドの概要
Name概要

get

 

remove

 

5.15.1. get GET
リンクのコピー

Expand
表5.41 パラメーターの概要
Nameタイプ方向概要

disk_profile

DiskProfile

Out

 

5.15.2. remove DELETE
リンクのコピー

Expand
表5.42 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.16. AssignedDiskProfiles
リンクのコピー

Expand
表5.43 メソッドの概要
Name概要

add

 

list

 

5.16.1. add POST
リンクのコピー

Expand
表5.44 パラメーターの概要
Nameタイプ方向概要

profile

DiskProfile

In/Out

 

5.16.2. list GET
リンクのコピー

Expand
表5.45 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロファイルの最大数を設定します。

profiles

DiskProfile[]

Out

 
5.16.2.1. max
リンクのコピー

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

5.17. AssignedNetwork
リンクのコピー

Expand
表5.46 メソッドの概要
Name概要

get

 

remove

 

update

 

5.17.1. get GET
リンクのコピー

Expand
表5.47 パラメーターの概要
Nameタイプ方向概要

network

Network

Out

 

5.17.2. remove DELETE
リンクのコピー

Expand
表5.48 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.17.3. update PUT
リンクのコピー

Expand
表5.49 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

network

Network

In/Out

 

5.18. AssignedNetworks
リンクのコピー

Expand
表5.50 メソッドの概要
Name概要

add

 

list

 

5.18.1. add POST
リンクのコピー

Expand
表5.51 パラメーターの概要
Nameタイプ方向概要

network

Network

In/Out

 

5.18.2. list GET
リンクのコピー

Expand
表5.52 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すネットワークの最大数を設定します。

networks

Network[]

Out

 
5.18.2.1. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

5.19. AssignedPermissions
リンクのコピー

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

Expand
表5.53 メソッドの概要
Name概要

add

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

list

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

5.19.1. add POST
リンクのコピー

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

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

POST /ovirt-engine/api/vms/123/permissions
Copy to Clipboard Toggle word wrap

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

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>
Copy to Clipboard Toggle word wrap

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

POST /ovirt-engine/api/permissions
Copy to Clipboard Toggle word wrap

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

<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
Copy to Clipboard Toggle word wrap

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

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>
Copy to Clipboard Toggle word wrap
Expand
表5.54 パラメーターの概要
Nameタイプ方向概要

permission

パーミッション

In/Out

パーミッション。

5.19.2. list GET
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap
Expand
表5.55 パラメーターの概要
Nameタイプ方向概要

permissions

Permission[]

Out

パーミッションのリスト

5.20. AssignedRoles
リンクのコピー

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

Expand
表5.56 メソッドの概要
Name概要

list

 

5.20.1. list GET
リンクのコピー

Expand
表5.57 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すロールの最大数を設定します。

roles

Role[]

Out

 
5.20.1.1. max
リンクのコピー

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

5.21. AssignedTag
リンクのコピー

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

Expand
表5.58 メソッドの概要
Name概要

get

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

remove

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

5.21.1. get GET
リンクのコピー

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

たとえば、id 123 の仮想マシンに割り当てられる id 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>
Copy to Clipboard Toggle word wrap
Expand
表5.59 パラメーターの概要
Nameタイプ方向概要

tag

タグ

Out

割り当てられたタグ。

5.21.2. remove DELETE
リンクのコピー

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

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

DELETE /ovirt-engine/api/vms/123/tags/456
Copy to Clipboard Toggle word wrap
Expand
表5.60 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.22. AssignedTags
リンクのコピー

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

Expand
表5.61 メソッドの概要
Name概要

add

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

list

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

5.22.1. add POST
リンクのコピー

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

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

POST /ovirt-engine/api/vms/123/tags
Copy to Clipboard Toggle word wrap

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

<tag>
  <name>mytag</name>
</tag>
Copy to Clipboard Toggle word wrap
Expand
表5.62 パラメーターの概要
Nameタイプ方向概要

tag

タグ

In/Out

割り当てられたタグ。

5.22.2. list GET
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap
Expand
表5.63 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すタグの最大数を設定します。

tags

Tag[]

Out

割り当てられたタグの一覧。

5.22.2.1. max
リンクのコピー

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

5.23. AssignedVnicProfile
リンクのコピー

Expand
表5.64 メソッドの概要
Name概要

get

 

remove

 

5.23.1. get GET
リンクのコピー

Expand
表5.65 パラメーターの概要
Nameタイプ方向概要

profile

VnicProfile

Out

 

5.23.2. remove DELETE
リンクのコピー

Expand
表5.66 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.24. AssignedVnicProfiles
リンクのコピー

Expand
表5.67 メソッドの概要
Name概要

add

 

list

 

5.24.1. add POST
リンクのコピー

Expand
表5.68 パラメーターの概要
Nameタイプ方向概要

profile

VnicProfile

In/Out

 

5.24.2. list GET
リンクのコピー

Expand
表5.69 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロファイルの最大数を設定します。

profiles

VnicProfile[]

Out

 
5.24.2.1. max
リンクのコピー

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

5.25. AttachedStorageDomain
リンクのコピー

Expand
表5.70 メソッドの概要
Name概要

activate

この操作により、割り当てられたストレージドメインがアクティベートされます。

deactivate

この操作により、接続されたストレージドメインが非アクティブになります。

get

 

remove

 

5.25.1. activate POST
リンクのコピー

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

POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate
Copy to Clipboard Toggle word wrap

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

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.71 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクティベーションを非同期で実行する必要があるかどうかを示します。

5.25.2. deactivate POST
リンクのコピー

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

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate
Copy to Clipboard Toggle word wrap

deactivate アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.72 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

非アクティブ化を非同期で実行する必要があるかどうかを示します。

5.25.3. get GET
リンクのコピー

Expand
表5.73 パラメーターの概要
Nameタイプ方向概要

storage_domain

StorageDomain

Out

 

5.25.4. remove DELETE
リンクのコピー

Expand
表5.74 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.26. AttachedStorageDomains
リンクのコピー

Expand
表5.75 メソッドの概要
Name概要

add

 

list

 

5.26.1. add POST
リンクのコピー

Expand
表5.76 パラメーターの概要
Nameタイプ方向概要

storage_domain

StorageDomain

In/Out

 

5.26.2. list GET
リンクのコピー

Expand
表5.77 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すストレージドメインの最大数を設定します。

storage_domains

StorageDomain[]

Out

 
5.26.2.1. max
リンクのコピー

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

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

Expand
表5.78 メソッドの概要
Name概要

get

 

remove

 

5.27.1. get GET
リンクのコピー

Expand
表5.79 パラメーターの概要
Nameタイプ方向概要

balance

バランス

Out

 

filter

ブール値

In

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

5.27.2. remove DELETE
リンクのコピー

Expand
表5.80 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

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

Expand
表5.81 メソッドの概要
Name概要

add

 

list

 

5.28.1. add POST
リンクのコピー

Expand
表5.82 パラメーターの概要
Nameタイプ方向概要

balance

バランス

In/Out

 

5.28.2. list GET
リンクのコピー

Expand
表5.83 パラメーターの概要
Nameタイプ方向概要

balances

Balance[]

Out

 

filter

ブール値

In

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

max

Integer

In

返すバランスの最大数を設定します。

5.28.2.1. max
リンクのコピー

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

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

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

Expand
表5.84 メソッドの概要
Name概要

get

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

remove

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

update

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

5.29.1. get GET
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap
Expand
表5.85 パラメーターの概要
Nameタイプ方向概要

bookmark

ブックマーク

Out

要求されたブックマーク。

5.29.2. remove DELETE
リンクのコピー

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

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

DELETE /ovirt-engine/api/bookmarks/123
Copy to Clipboard Toggle word wrap
Expand
表5.86 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.29.3. update PUT
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap
Expand
表5.87 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

bookmark

ブックマーク

In/Out

更新されたブックマーク。

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

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

Expand
表5.88 メソッドの概要
Name概要

add

新規ブックマークの追加

list

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

5.30.1. add POST
リンクのコピー

新規ブックマークの追加

ブックマークの追加例: 

POST /ovirt-engine/api/bookmarks
Copy to Clipboard Toggle word wrap 
<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>
Copy to Clipboard Toggle word wrap
Expand
表5.89 パラメーターの概要
Nameタイプ方向概要

bookmark

ブックマーク

In/Out

追加されたブックマーク。

5.30.2. list GET
リンクのコピー

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

ブックマークの一覧表示例: 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.90 パラメーターの概要
Nameタイプ方向概要

bookmarks

bookmark[]

Out

利用可能なブックマークの一覧。

max

Integer

In

返すブックマークの最大数を設定します。

5.30.2.1. max
リンクのコピー

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

5.31. Cluster
リンクのコピー

特定のクラスターを管理するサービス。

Expand
表5.91 メソッドの概要
Name概要

get

クラスターに関する情報を取得します。

remove

システムからクラスターを削除します。

resetemulatedmachine

 

update

クラスターに関する情報を更新します。

5.31.1. get GET
リンクのコピー

クラスターに関する情報を取得します。

クラスターを取得する例: 

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 Penryn 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>
  <maintenance_reason_required>false</maintenance_reason_required>
  <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>
  <optional_reason>false</optional_reason>
  <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
表5.92 パラメーターの概要
Nameタイプ方向概要

cluster

Cluster

Out

 

filter

ブール値

In

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

5.31.2. remove DELETE
リンクのコピー

システムからクラスターを削除します。 

DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000
Copy to Clipboard Toggle word wrap
Expand
表5.93 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.31.3. resetemulatedmachine POST
リンクのコピー

Expand
表5.94 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

リセットを非同期で実行する必要があるかどうかを示します。

5.31.4. update PUT
リンクのコピー

クラスターに関する情報を更新します。

指定されたフィールドのみが更新されます。その他は変更されません。

たとえば、クラスターの CPU を更新します。 

PUT /ovirt-engine/api/clusters/123
Copy to Clipboard Toggle word wrap

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

<cluster>
  <cpu>
    <type>Intel Haswell-noTSX Family</type>
  </cpu>
</cluster>
Copy to Clipboard Toggle word wrap
Expand
表5.95 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

cluster

Cluster

In/Out

 

5.32. ClusterLevel
リンクのコピー

特定のクラスターレベルに関する情報を提供します。詳細は、ClusterLevels サービスを参照してください。

Expand
表5.96 メソッドの概要
Name概要

get

このサービスが管理する特定のクラスターレベルの機能に関する情報を提供します。

5.32.1. get GET
リンクのコピー

このサービスが管理する特定のクラスターレベルの機能に関する情報を提供します。

たとえば、レベル 3.6 でサポートされる CPU タイプを確認するには、以下のように要求を送信できます。 

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 Conroe 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
表5.97 パラメーターの概要
Nameタイプ方向概要

level

ClusterLevel

Out

取得したクラスターレベル。

5.33. ClusterLevels
リンクのコピー

エンジンがサポートするさまざまなクラスターレベルの機能に関する情報を提供します。エンジンのバージョン 4.0 は、レベル 4.0 および 3.6 をサポートします。これらのレベルのそれぞれは、さまざまな CPU タイプのセットをサポートします。以下に例を示します。このサービスは、その情報を提供します。

Expand
表5.98 メソッドの概要
Name概要

list

システムがサポートするクラスターレベルを一覧表示します。

5.33.1. list GET
リンクのコピー

システムがサポートするクラスターレベルを一覧表示します。 

GET /ovirt-engine/api/clusterlevels
Copy to Clipboard Toggle word wrap

これにより、利用可能なクラスターレベルのリストが返されます。 

<cluster_levels>
  <cluster_level id="4.0">
     ...
  </cluster_level>
  ...
</cluster_levels>
Copy to Clipboard Toggle word wrap
Expand
表5.99 パラメーターの概要
Nameタイプ方向概要

levels

ClusterLevel[]

Out

取得されるクラスターレベル。

5.34. クラスター
リンクのコピー

クラスターを管理するサービス

Expand
表5.100 メソッドの概要
Name概要

add

新規クラスターを作成します。

list

 

5.34.1. add POST
リンクのコピー

新規クラスターを作成します。

これには、name 属性、cpu.type 属性、および data_center 属性が必要です。id または name 属性のいずれかでデータセンターを特定します。 

POST /ovirt-engine/api/clusters
Copy to Clipboard Toggle word wrap

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

<cluster>
  <name>mycluster</name>
  <cpu>
    <type>Intel Penryn Family</type>
  </cpu>
  <data_center id="123"/>
</cluster>
Copy to Clipboard Toggle word wrap
Expand
表5.101 パラメーターの概要
Nameタイプ方向概要

cluster

Cluster

In/Out

 

5.34.2. list GET
リンクのコピー

Expand
表5.102 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

clusters

Cluster[]

Out

 

filter

ブール値

In

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

max

Integer

In

返すことのできるクラスターの最大数。

search

String

In

返されたクラスターを制限するために使用されるクエリー文字列。

5.34.2.1. case_sensitive
リンクのコピー

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

5.34.2.2. max
リンクのコピー

返すことのできるクラスターの最大数。指定されていない場合は、すべてのクラスターが返されます。

5.35. コピー可能
リンクのコピー

Expand
表5.103 メソッドの概要
Name概要

copy

 

5.35.1. copy POST
リンクのコピー

Expand
表5.104 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

コピーを非同期的に実行するかどうかを指定します。

5.36. CpuProfile
リンクのコピー

Expand
表5.105 メソッドの概要
Name概要

get

 

remove

 

update

 

5.36.1. get GET
リンクのコピー

Expand
表5.106 パラメーターの概要
Nameタイプ方向概要

profile

CpuProfile

Out

 

5.36.2. remove DELETE
リンクのコピー

Expand
表5.107 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.36.3. update PUT
リンクのコピー

Expand
表5.108 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

profile

CpuProfile

In/Out

 

5.37. CpuProfiles
リンクのコピー

Expand
表5.109 メソッドの概要
Name概要

add

 

list

 

5.37.1. add POST
リンクのコピー

Expand
表5.110 パラメーターの概要
Nameタイプ方向概要

profile

CpuProfile

In/Out

 

5.37.2. list GET
リンクのコピー

Expand
表5.111 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロファイルの最大数を設定します。

profile

CpuProfile[]

Out

 
5.37.2.1. max
リンクのコピー

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

5.38. DataCenter
リンクのコピー

データセンターを管理するサービス

Expand
表5.112 メソッドの概要
Name概要

get

データセンターを取得します。

remove

データセンターを削除します。

update

データセンターを更新します。

5.38.1. get GET
リンクのコピー

データセンターを取得します。

データセンターを取得する例: 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.113 パラメーターの概要
Nameタイプ方向概要

data_center

DataCenter

Out

 

filter

ブール値

In

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

5.38.2. remove DELETE
リンクのコピー

データセンターを削除します。 

DELETE /ovirt-engine/api/datacenters/123
Copy to Clipboard Toggle word wrap

特別なパラメーターがないと、データセンターにアタッチされたストレージドメインは切り離され、ストレージから削除されます。この操作の実行中に何かが失敗した場合、たとえば、ストレージからストレージドメインを削除するために使用できるホストがない場合、操作全体が失敗します。

force パラメーターが true の場合、たとえば 1 つのストレージドメインの削除中に何かが失敗した場合でも、操作は常に成功します。障害は無視され、データセンターがデータベースから削除されます。

Expand
表5.114 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

force

ブール値

In

操作中に何かが失敗した場合でも、操作が成功し、ストレージドメインがデータベースから削除されるかどうかを示します。

5.38.2.1. force
リンクのコピー

操作中に何かが失敗した場合でも、操作が成功し、ストレージドメインがデータベースから削除されるかどうかを示します。

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

5.38.3. update PUT
リンクのコピー

データセンターを更新します。

name、description、storage_type、version、storage_format、および mac_pool 要素は、作成後に更新可能です。たとえば、データセンター 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>
Copy to Clipboard Toggle word wrap
Expand
表5.115 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

data_center

DataCenter

In/Out

更新されたデータセンター。

5.39. DataCenters
リンクのコピー

データセンターを管理するサービス

Expand
表5.116 メソッドの概要
Name概要

add

新しいデータセンターを作成します。

list

データセンターを一覧表示します。

5.39.1. add POST
リンクのコピー

新しいデータセンターを作成します。

新しいデータセンターを作成するには、name および local 要素が必要です。たとえば、共有ストレージ (NFS、iSCSI、またはファイバーチャネル) を使用する mydc という名前のデータセンターを作成するには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/datacenters
Copy to Clipboard Toggle word wrap

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

<data_center>
  <name>mydc</name>
  <local>false</local>
</data_center>
Copy to Clipboard Toggle word wrap
Expand
表5.117 パラメーターの概要
Nameタイプ方向概要

data_center

DataCenter

In/Out

追加するデータセンター。

5.39.2. list GET
リンクのコピー

データセンターを一覧表示します。

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

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
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>
Copy to Clipboard Toggle word wrap

Default データセンターの ID コードに注意してください。このコードは、仮想環境の他のリソースに関連して、このデータセンターを特定します。

データセンターには、ストレージドメインコレクションへのリンクも含まれています。データセンターはこのコレクションを使用して、ストレージドメインのメインコレクションからストレージドメインを割り当てます。

Expand
表5.118 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

data_centers

DataCenter[]

Out

 

filter

ブール値

In

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

max

Integer

In

返すデータセンターの最大数を設定します。

search

String

In

返されたデータセンターを制限するために使用されるクエリー文字列。

5.39.2.1. case_sensitive
リンクのコピー

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

5.39.2.2. max
リンクのコピー

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

5.40. ディスク
リンクのコピー

単一ディスクを管理します。

Expand
表5.119 メソッドの概要
Name概要

copy

この操作により、指定されたストレージドメインにディスクをコピーします。

export

 

get

 

move

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

remove

 

5.40.1. copy POST
リンクのコピー

この操作により、指定されたストレージドメインにディスクをコピーします。

たとえば、以下の要求を使用してディスクのコピーを容易にすることができます。 

POST /ovirt-engine/api/disks/123/copy
Copy to Clipboard Toggle word wrap

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

<action>
  <storage_domain id="456"/>
  <disk>
    <name>mydisk</name>
  </disk>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.120 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

コピーを非同期的に実行するかどうかを指定します。

disk

ディスク

In

 

filter

ブール値

In

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

storage_domain

StorageDomain

In

 

5.40.2. export POST
リンクのコピー

Expand
表5.121 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

エクスポートを非同期で実行する必要があるかどうかを示します。

filter

ブール値

In

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

storage_domain

StorageDomain

In

 

5.40.3. get GET
リンクのコピー

Expand
表5.122 パラメーターの概要
Nameタイプ方向概要

disk

ディスク

Out

 

5.40.4. move POST
リンクのコピー

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

たとえば、識別子 123 のディスクを、識別子 456 が指定されたストレージドメインに移動するには、以下のリクエストを送信します。 

POST /ovirt-engine/api/disks/123/move
Copy to Clipboard Toggle word wrap

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

<action>
  <storage_domain id="456"/>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.123 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

移動を非同期で実行する必要があるかどうかを示します。

filter

ブール値

In

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

storage_domain

StorageDomain

In

 

5.40.5. remove DELETE
リンクのコピー

Expand
表5.124 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.41. DiskAttachment
リンクのコピー

このサービスは、仮想マシンへのディスクの接続を管理します。

Expand
表5.125 メソッドの概要
Name概要

get

起動フラグやディスクへのリンクなど、添付ファイルの詳細を返します。

remove

ディスクアタッチメントを削除します。

update

ディスクアタッチメントとその中のディスクプロパティーを更新します。

5.41.1. get GET
リンクのコピー

起動フラグやディスクへのリンクなど、添付ファイルの詳細を返します。

ディスク接続を取得する例: 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.126 パラメーターの概要
Nameタイプ方向概要

attachment

DiskAttachment

Out

 

5.41.2. remove DELETE
リンクのコピー

ディスクアタッチメントを削除します。

これにより、仮想マシンからディスクがデタッチされるだけで、detach_only パラメーターが false でない限り、システムからディスクが削除されることはありません。

ディスクアタッチメントを削除する例: 

DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true
Copy to Clipboard Toggle word wrap
Expand
表5.127 パラメーターの概要
Nameタイプ方向概要

detach_only

ブール値

In

ディスクを仮想マシンからのみ切り離す必要があり、システムからは切り離さないようにする必要があるかどうかを示します。

5.41.2.1. detach_only
リンクのコピー

ディスクを仮想マシンからのみ切り離す必要があり、システムからは切り離さないようにする必要があるかどうかを示します。デフォルト値は true で、システムからディスクを削除しません。

5.41.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>
Copy to Clipboard Toggle word wrap
Expand
表5.128 パラメーターの概要
Nameタイプ方向概要

disk_attachment

DiskAttachment

In/Out

 

5.42. DiskAttachments
リンクのコピー

このサービスは、仮想マシンにアタッチされている一連のディスクを管理します。アタッチされている各ディスクは、起動可能フラグ、ディスクインターフェイス、およびディスクへの参照を含む DiskAttachment で表されます。

Expand
表5.129 メソッドの概要
Name概要

add

仮想マシンに新しいディスクアタッチメントを追加します。

list

仮想マシンに接続されているディスクを一覧表示します。

5.42.1. add POST
リンクのコピー

仮想マシンに新しいディスクアタッチメントを追加します。ディスクがすでに存在する場合は、attachment パラメーターには参照のみを含めることができます。 

<disk_attachment>
  <bootable>true</bootable>
  <interface>ide</interface>
  <active>true</active>
  <disk id="123"/>
</disk_attachment>
Copy to Clipboard Toggle word wrap

または、ディスクがまだ存在しない場合には、ディスクの完全な表現を含めることができます。 

<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

この場合、ディスクが作成され、仮想マシンに割り当てられます。

いずれの場合も、ID 345 の仮想マシンに以下の URL を使用します。 

POST /ovirt-engine/api/vms/345/diskattachments
Copy to Clipboard Toggle word wrap
重要

サーバーは active 属性を含まないリクエストを受け入れますが、その効果は定義されていません。場合によっては、ディスクが自動的にアクティベートされ、その他の場合は自動的にアクティブになりません。問題を回避するには、希望の値で active 属性を常に含めることを強く推奨します。

Expand
表5.130 パラメーターの概要
Nameタイプ方向概要

attachment

DiskAttachment

In/Out

 

5.42.2. list GET
リンクのコピー

仮想マシンに接続されているディスクを一覧表示します。

Expand
表5.131 パラメーターの概要
Nameタイプ方向概要

attachments

DiskAttachment[]

Out

 

5.43. DiskProfile
リンクのコピー

Expand
表5.132 メソッドの概要
Name概要

get

 

remove

 

update

 

5.43.1. get GET
リンクのコピー

Expand
表5.133 パラメーターの概要
Nameタイプ方向概要

profile

DiskProfile

Out

 

5.43.2. remove DELETE
リンクのコピー

Expand
表5.134 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.43.3. update PUT
リンクのコピー

Expand
表5.135 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

profile

DiskProfile

In/Out

 

5.44. DiskProfiles
リンクのコピー

Expand
表5.136 メソッドの概要
Name概要

add

 

list

 

5.44.1. add POST
リンクのコピー

Expand
表5.137 パラメーターの概要
Nameタイプ方向概要

profile

DiskProfile

In/Out

 

5.44.2. list GET
リンクのコピー

Expand
表5.138 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロファイルの最大数を設定します。

profile

DiskProfile[]

Out

 
5.44.2.1. max
リンクのコピー

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

5.45. DiskSnapshot
リンクのコピー

Expand
表5.139 メソッドの概要
Name概要

get

 

remove

 

5.45.1. get GET
リンクのコピー

Expand
表5.140 パラメーターの概要
Nameタイプ方向概要

snapshot

DiskSnapshot

Out

 

5.45.2. remove DELETE
リンクのコピー

Expand
表5.141 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.46. DiskSnapshots
リンクのコピー

Expand
表5.142 メソッドの概要
Name概要

list

 

5.46.1. list GET
リンクのコピー

Expand
表5.143 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すスナップショットの最大数を設定します。

snapshots

DiskSnapshot[]

Out

 
5.46.1.1. max
リンクのコピー

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

5.47. ディスク
リンクのコピー

システムで利用可能なディスクのコレクションを管理します。

Expand
表5.144 メソッドの概要
Name概要

add

新しいフローティングディスクを追加します。

list

ディスクの一覧を取得します。

5.47.1. add POST
リンクのコピー

新しいフローティングディスクを追加します。

新しいフローティング ディスク を作成する場合、API には storage_domain、provisioned_size、および format 属性が必要です。

ID e9fedf39-5edc-4e0a-8628-253f1b9c5693 のストレージドメインに provisioned_size、format、name を指定して新しいフローティングディスクを作成するには、以下のように要求を送信します。 

POST /ovirt-engine/api/disks
Copy to Clipboard Toggle word wrap

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

<disk>
  <storage_domains>
    <storage_domain id="e9fedf39-5edc-4e0a-8628-253f1b9c5693"/>
  </storage_domains>
  <name>disk1</name>
  <provisioned_size>1048576</provisioned_size>
  <format>cow</format>
</disk>
Copy to Clipboard Toggle word wrap
Expand
表5.145 パラメーターの概要
Nameタイプ方向概要

disk

ディスク

In/Out

ディスク。

5.47.2. list GET
リンクのコピー

ディスクの一覧を取得します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.146 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

disks

Disk[]

Out

取得されたディスクの一覧。

max

Integer

In

返すディスクの最大数を設定します。

search

String

In

返されたディスクを制限するために使用されるクエリー文字列。

5.47.2.1. case_sensitive
リンクのコピー

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

5.47.2.2. max
リンクのコピー

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

5.48. Domain
リンクのコピー

システム内の認証ドメインの詳細を表示するサービス

Expand
表5.147 メソッドの概要
Name概要

get

認証ドメイン情報を取得します。

5.48.1. get GET
リンクのコピー

認証ドメイン情報を取得します。

使用方法 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.148 パラメーターの概要
Nameタイプ方向概要

domain

Domain

Out

認証ドメイン。

5.49. DomainGroup
リンクのコピー

Expand
表5.149 メソッドの概要
Name概要

get

 

5.49.1. get GET
リンクのコピー

Expand
表5.150 パラメーターの概要
Nameタイプ方向概要

get

グループ

Out

 

5.50. DomainGroups
リンクのコピー

Expand
表5.151 メソッドの概要
Name概要

list

 

5.50.1. list GET
リンクのコピー

Expand
表5.152 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

groups

Group[]

Out

 

max

Integer

In

返すグループの最大数を設定します。

search

String

In

返されるグループを制限するために使用されるクエリー文字列。

5.50.1.1. case_sensitive
リンクのコピー

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

5.50.1.2. max
リンクのコピー

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

5.51. DomainUser
リンクのコピー

システム内のドメインユーザーを表示するサービス

Expand
表5.153 メソッドの概要
Name概要

get

ドメインユーザー情報を取得します。

5.51.1. get GET
リンクのコピー

ドメインユーザー情報を取得します。

使用方法 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.154 パラメーターの概要
Nameタイプ方向概要

user

User

Out

ドメインユーザー。

5.52. DomainUsers
リンクのコピー

システム内のすべてのドメインユーザーを一覧表示するサービス。

Expand
表5.155 メソッドの概要
Name概要

list

ドメイン内のすべてのユーザーを一覧表示します。

5.52.1. list GET
リンクのコピー

ドメイン内のすべてのユーザーを一覧表示します。

使用方法 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.156 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

max

Integer

In

返すユーザーの最大数を設定します。

search

String

In

返されるユーザーを制限するために使用されるクエリー文字列。

users

User[]

Out

ドメイン内のユーザーのリスト。

5.52.1.1. case_sensitive
リンクのコピー

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

5.52.1.2. max
リンクのコピー

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

5.53. ドメイン
リンクのコピー

システム内のすべての認証ドメインを一覧表示するサービス。

Expand
表5.157 メソッドの概要
Name概要

list

システム内のすべての認証ドメインを一覧表示します。

5.53.1. list GET
リンクのコピー

システム内のすべての認証ドメインを一覧表示します。

使用方法 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.158 パラメーターの概要
Nameタイプ方向概要

domains

Domain[]

Out

ドメインの一覧。

max

Integer

In

返すドメインの最大数を設定します。

5.53.1.1. max
リンクのコピー

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

5.54. EngineKatelloErrata
リンクのコピー

エンジンに割り当てられた Katello エラータを管理するサービスこの情報は Katello から取得されます。

Expand
表5.159 メソッドの概要
Name概要

list

Katello エラータの表現を取得します。

5.54.1. list GET
リンクのコピー

Katello エラータの表現を取得します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.160 パラメーターの概要
Nameタイプ方向概要

errata

KatelloErratum[]

Out

Katello エラータの表現。

max

Integer

In

返すエラータの最大数を設定します。

5.54.1.1. max
リンクのコピー

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

5.55. イベント
リンクのコピー

システムのイベントを管理するサービス。

Expand
表5.161 メソッドの概要
Name概要

get

イベントを取得します。

remove

内部監査ログからイベントを削除します。

5.55.1. get GET
リンクのコピー

イベントを取得します。

イベントの取得例: 

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>
Copy to Clipboard Toggle word wrap

イベントにある情報に応じてフィールドの数が変わることに注意してください。たとえば、ストレージドメイン関連のイベントの場合、ストレージドメインの参照と、このストレージドメインが置かれているデータセンターのリファレンスを取得します。

Expand
表5.162 パラメーターの概要
Nameタイプ方向概要

event

イベント

Out

 

5.55.2. remove DELETE
リンクのコピー

内部監査ログからイベントを削除します。

以下のリクエストを送信するとイベントを削除できます。 

DELETE /ovirt-engine/api/events/123
Copy to Clipboard Toggle word wrap
Expand
表5.163 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.56. イベント
リンクのコピー

システムのイベントを管理するサービス。

Expand
表5.164 メソッドの概要
Name概要

add

外部イベントを内部監査ログに追加します。

list

イベントの一覧を取得します。

undelete

 

5.56.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>
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>
Copy to Clipboard Toggle word wrap
注記

前述の例の vm のようにリンクを使用する場合は、id 属性のみが許可されます。name 属性 (指定されている場合) は無視されます。

Expand
表5.165 パラメーターの概要
Nameタイプ方向概要

event

イベント

In/Out

 

5.56.2. list GET
リンクのコピー

イベントの一覧を取得します。 

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>
Copy to Clipboard Toggle word wrap

以下のイベントが発生します。

  • id="1": 管理ユーザーアカウントの API ログイン。
  • id="2": API は admin ユーザーアカウントからログアウトします。
Expand
表5.166 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

events

Event[]

Out

 

from

Integer

In

返される最初のイベントの識別子を示します。

max

Integer

In

返すイベントの最大数を設定します。

search

String

In

イベントサービスは、他のリソースサービスと同様に検索クエリーを提供します。

5.56.2.1. case_sensitive
リンクのコピー

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

5.56.2.2. from
リンクのコピー

返される最初のイベントの識別子を示します。イベントの識別子は厳密に増加しているため、このパラメーターを使用すると、その識別子が指定の値以上のイベントのみが返されます。たとえば、以下のリクエストは 123 以上の識別子のイベントのみを返します。 

GET /ovirt-engine/api/events?from=123
Copy to Clipboard Toggle word wrap

このパラメーターは任意です。指定されていない場合には、返される最初のイベントが最後に生成されます。

5.56.2.3. max
リンクのコピー

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

5.56.3. undelete POST
リンクのコピー

Expand
表5.167 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除解除を非同期的に実行するかどうかを示します。

5.57. ExternalComputeResource
リンクのコピー

Expand
表5.168 メソッドの概要
Name概要

get

 

5.57.1. get GET
リンクのコピー

Expand
表5.169 パラメーターの概要
Nameタイプ方向概要

resource

ExternalComputeResource

Out

 

5.58. ExternalComputeResources
リンクのコピー

Expand
表5.170 メソッドの概要
Name概要

list

 

5.58.1. list GET
リンクのコピー

Expand
表5.171 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すリソースの最大数を設定します。

resources

ExternalComputeResource[]

Out

 
5.58.1.1. max
リンクのコピー

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

5.59. ExternalDiscoveredHost
リンクのコピー

Expand
表5.172 メソッドの概要
Name概要

get

 

5.59.1. get GET
リンクのコピー

Expand
表5.173 パラメーターの概要
Nameタイプ方向概要

host

ExternalDiscoveredHost

Out

 

5.60. ExternalDiscoveredHosts
リンクのコピー

Expand
表5.174 メソッドの概要
Name概要

list

 

5.60.1. list GET
リンクのコピー

Expand
表5.175 パラメーターの概要
Nameタイプ方向概要

hosts

ExternalDiscoveredHost[]

Out

 

max

Integer

In

返すホストの最大数を設定します。

5.60.1.1. max
リンクのコピー

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

5.61. ExternalHost
リンクのコピー

Expand
表5.176 メソッドの概要
Name概要

get

 

5.61.1. get GET
リンクのコピー

Expand
表5.177 パラメーターの概要
Nameタイプ方向概要

host

ExternalHost

Out

 

5.62. ExternalHostGroup
リンクのコピー

Expand
表5.178 メソッドの概要
Name概要

get

 

5.62.1. get GET
リンクのコピー

Expand
表5.179 パラメーターの概要
Nameタイプ方向概要

group

ExternalHostGroup

Out

 

5.63. ExternalHostGroups
リンクのコピー

Expand
表5.180 メソッドの概要
Name概要

list

 

5.63.1. list GET
リンクのコピー

Expand
表5.181 パラメーターの概要
Nameタイプ方向概要

groups

ExternalHostGroup[]

Out

 

max

Integer

In

返すグループの最大数を設定します。

5.63.1.1. max
リンクのコピー

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

5.64. ExternalHostProvider
リンクのコピー

Expand
表5.182 メソッドの概要
Name概要

get

 

importcertificates

 

remove

 

testconnectivity

 

update

 

5.64.1. get GET
リンクのコピー

Expand
表5.183 パラメーターの概要
Nameタイプ方向概要

provider

ExternalHostProvider

Out

 

5.64.2. importcertificates POST
リンクのコピー

Expand
表5.184 パラメーターの概要
Nameタイプ方向概要

certificates

Certificate[]

In

 

5.64.3. remove DELETE
リンクのコピー

Expand
表5.185 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.64.4. testconnectivity POST
リンクのコピー

Expand
表5.186 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

テストを非同期で実行する必要があるかどうかを示します。

5.64.5. update PUT
リンクのコピー

Expand
表5.187 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

provider

ExternalHostProvider

In/Out

 

5.65. ExternalHostProviders
リンクのコピー

Expand
表5.188 メソッドの概要
Name概要

add

 

list

 

5.65.1. add POST
リンクのコピー

Expand
表5.189 パラメーターの概要
Nameタイプ方向概要

provider

ExternalHostProvider

In/Out

 

5.65.2. list GET
リンクのコピー

Expand
表5.190 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロバイダーの最大数を設定します。

providers

ExternalHostProvider[]

Out

 
5.65.2.1. max
リンクのコピー

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

5.66. ExternalHosts
リンクのコピー

Expand
表5.191 メソッドの概要
Name概要

list

 

5.66.1. list GET
リンクのコピー

Expand
表5.192 パラメーターの概要
Nameタイプ方向概要

hosts

ExternalHost[]

Out

 

max

Integer

In

返すホストの最大数を設定します。

5.66.1.1. max
リンクのコピー

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

5.67. ExternalProvider
リンクのコピー

Expand
表5.193 メソッドの概要
Name概要

importcertificates

 

testconnectivity

 

5.67.1. importcertificates POST
リンクのコピー

Expand
表5.194 パラメーターの概要
Nameタイプ方向概要

certificates

Certificate[]

In

 

5.67.2. testconnectivity POST
リンクのコピー

Expand
表5.195 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

テストを非同期で実行する必要があるかどうかを示します。

5.68. ExternalProviderCertificate
リンクのコピー

Expand
表5.196 メソッドの概要
Name概要

get

 

5.68.1. get GET
リンクのコピー

Expand
表5.197 パラメーターの概要
Nameタイプ方向概要

certificate

証明書

Out

 

5.69. ExternalProviderCertificates
リンクのコピー

Expand
表5.198 メソッドの概要
Name概要

list

 

5.69.1. list GET
リンクのコピー

Expand
表5.199 パラメーターの概要
Nameタイプ方向概要

certificates

Certificate[]

Out

 

max

Integer

In

返す証明書の最大数を設定します。

5.69.1.1. max
リンクのコピー

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

5.70. ExternalVmImports
リンクのコピー

外部仮想マシンをインポートする機能を提供します。

Expand
表5.200 メソッドの概要
Name概要

add

この操作は、KVM、XEN、VMware などの外部ハイパーバイザーから仮想マシンをインポートするために使用されます。

5.70.1. add POST
リンクのコピー

この操作は、KVM、XEN、VMware などの外部ハイパーバイザーから仮想マシンをインポートするために使用されます。

たとえば、VMware からの仮想マシンのインポートは、次のリクエストを使用して簡単に行うことができます。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.201 パラメーターの概要
Nameタイプ方向概要

import

ExternalVmImport

In/Out

 

5.71. FenceAgent
リンクのコピー

Expand
表5.202 メソッドの概要
Name概要

get

 

remove

 

update

 

5.71.1. get GET
リンクのコピー

Expand
表5.203 パラメーターの概要
Nameタイプ方向概要

agent

Agent

Out

 

5.71.2. remove DELETE
リンクのコピー

Expand
表5.204 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.71.3. update PUT
リンクのコピー

Expand
表5.205 パラメーターの概要
Nameタイプ方向概要

agent

Agent

In/Out

 

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

5.72. FenceAgents
リンクのコピー

Expand
表5.206 メソッドの概要
Name概要

add

 

list

 

5.72.1. add POST
リンクのコピー

Expand
表5.207 パラメーターの概要
Nameタイプ方向概要

agent

Agent

In/Out

 

5.72.2. list GET
リンクのコピー

Expand
表5.208 パラメーターの概要
Nameタイプ方向概要

agents

Agent[]

Out

 

max

Integer

In

返すエージェントの最大数を設定します。

5.72.2.1. max
リンクのコピー

返すエージェントの最大数を設定します。指定しない場合、すべてのエージェントが返されます。

5.73. File
リンクのコピー

Expand
表5.209 メソッドの概要
Name概要

get

 

5.73.1. get GET
リンクのコピー

Expand
表5.210 パラメーターの概要
Nameタイプ方向概要

file

File

Out

 

5.74. ファイル
リンクのコピー

クライアントが利用可能なファイルを一覧表示する方法を提供します。

このサービスは、管理者がアップロードする ISO イメージおよび仮想フロッピーディスク(VFD)を含む ISO ストレージドメインを特別に対象としています。

CDROM デバイスを仮想マシンに追加するには、ISO ストレージドメインのファイルからの ISO イメージが必要です。

Expand
表5.211 メソッドの概要
Name概要

list

 

5.74.1. list GET
リンクのコピー

Expand
表5.212 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

file

File[]

Out

 

max

Integer

In

返すファイルの最大数を設定します。

search

String

In

返されたファイルを制限するために使用されるクエリー文字列。

5.74.1.1. case_sensitive
リンクのコピー

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

5.74.1.2. max
リンクのコピー

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

5.75. フィルター
リンクのコピー

Expand
表5.213 メソッドの概要
Name概要

get

 

remove

 

5.75.1. get GET
リンクのコピー

Expand
表5.214 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

result

フィルター

Out

 

5.75.2. remove DELETE
リンクのコピー

Expand
表5.215 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.76. フィルター
リンクのコピー

Expand
表5.216 メソッドの概要
Name概要

add

 

list

 

5.76.1. add POST
リンクのコピー

Expand
表5.217 パラメーターの概要
Nameタイプ方向概要

filter

フィルター

In/Out

 

5.76.2. list GET
リンクのコピー

Expand
表5.218 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

filters

Filter[]

Out

 

max

Integer

In

返すフィルターの最大数を設定します。

5.76.2.1. max
リンクのコピー

返すフィルターの最大数を設定します。指定しない場合、すべてのエージェントが返されます。

5.77. GlusterBrick
リンクのコピー

このサービスは単一の gluster ブリックを管理します。

Expand
表5.219 メソッドの概要
Name概要

get

ブリックの詳細を取得します。

remove

ブリックを削除します。

replace

このブリックを新しいものに置き換えます。

5.77.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
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>
Copy to Clipboard Toggle word wrap
Expand
表5.220 パラメーターの概要
Nameタイプ方向概要

brick

GlusterBrick

Out

 

5.77.2. remove DELETE
リンクのコピー

ブリックを削除します。

基礎となる gluster ボリュームからブリックを削除し、データベースからエントリーを削除します。これは、データ移行なしで単一のブリックを削除する場合にのみ使用できます。複数のブリックとデータ移行を削除するには、代わりに migrate を使用します。

たとえば、gluster ボリューム 123 からブリック 234 を削除するには、以下のように要求を送信します。 

DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
Copy to Clipboard Toggle word wrap
Expand
表5.221 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.77.3. replace POST
リンクのコピー

このブリックを新しいものに置き換えます。

重要

この操作はエンジンのバージョン 3.5 以降非推奨となり、今後削除されます。代わりに、add brick を使用してブリックを migrate brick します。

Expand
表5.222 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

代替を非同期的に実行するかどうかを指定します。

force

ブール値

In

 

5.78. GlusterBricks
リンクのコピー

このサービスは、gluster ボリュームで gluster ブリックを管理します。

Expand
表5.223 メソッドの概要
Name概要

activate

削除操作のデータ移行の後のデータ移行をアクティベートします。

add

gluster ボリュームに、ブリックの一覧を追加します。

list

gluster ボリュームのブリックを一覧表示します。

migrate

ブリックを削除する前にデータの移行を開始します。

remove

gluster ボリュームからブリックを削除します。

stopmigrate

削除のブリック操作についてのデータのブリックからの移行を停止します。

5.78.1. activate POST
リンクのコピー

削除操作のデータ移行の後のデータ移行をアクティベートします。

ブリックからのデータ移行が完了し、ユーザーがブリックを削除したくないと、ブリックをアクティベートするために使用されます。削除用に以前にマークされていたブリックは、通常のブリックとして使用されるようになりました。

たとえば、データの移行元である glustervolume 123 のブリックを保持するには、次のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.224 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクティベーションを非同期で実行する必要があるかどうかを示します。

bricks

GlusterBrick[]

In

再アクティベートする必要があるブリックの一覧。

5.78.2. add POST
リンクのコピー

gluster ボリュームに、ブリックの一覧を追加します。

ブリックを追加して gluster ボリュームを拡張するのに使用します。複製されたボリュームタイプの場合は、replica_count パラメーターを渡す必要があります。レプリカ数が増える場合、ブリックの数はレプリカセットの数と同じである必要があります。

たとえば、gluster ボリューム 123 にブリックを追加するには、次のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.225 パラメーターの概要
Nameタイプ方向概要

bricks

GlusterBrick[]

In/Out

ボリュームに追加するブリックの一覧

replica_count

Integer

In

ボリューム後の追加操作のレプリカ数。

stripe_count

Integer

In

追加後の操作のストライプ数。

5.78.3. list GET
リンクのコピー

gluster ボリュームのブリックを一覧表示します。

たとえば、gluster ボリューム 123 のブリックを一覧表示するには、以下のように要求を送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.226 パラメーターの概要
Nameタイプ方向概要

bricks

GlusterBrick[]

Out

 

max

Integer

In

返すブリックの最大数を設定します。

5.78.3.1. max
リンクのコピー

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

5.78.4. migrate POST
リンクのコピー

ブリックを削除する前にデータの移行を開始します。

ブリックの削除は 2 つのステップで、削除されるブリック上のデータが最初に残りのブリックに移行します。移行が完了すると、API remove を介してブリックの削除が確定されます。いずれの時点でも、stopmigrate をキャンセルするアクションを呼び出す必要があります。

たとえば、ID が 123 の gluster ボリュームからブリックを削除するには、次のリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap

移行プロセスは、ジョブを使用して API から返されたジョブ ID と、ステップを使用して job の step から追跡できます。

Expand
表5.227 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

移行を非同期的に実行するかどうかを指定します。

bricks

GlusterBrick[]

In

データ移行を開始する必要のあるブリックの一覧。

5.78.5. remove DELETE
リンクのコピー

gluster ボリュームからブリックを削除します。

データ損失なしでブリックを削除する場合は、最初に stopmigrate を使用してそれらのデータを削除してからそれらを削除する方法が推奨されます。削除前にイメージストリームで移行が呼び出されなかった場合、データ移行なしにブリックが削除され、データが失われる可能性があります。

たとえば、gluster ボリューム 123 からブリックを削除するには、以下のように要求を送信します。 

DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
Copy to Clipboard Toggle word wrap

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

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>
Copy to Clipboard Toggle word wrap
Expand
表5.228 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

bricks

GlusterBrick[]

In

削除するブリックの一覧

replica_count

Integer

In

ボリューム後の追加操作のレプリカ数。

5.78.6. stopmigrate POST
リンクのコピー

削除のブリック操作についてのデータのブリックからの移行を停止します。

ユーザーがブリックの使用を継続したい場合に備えて、2 ステップのブリック削除プロセスの一部として開始されたデータ移行をキャンセルするには。削除用にマーク付けされていたブリックは、この操作の後に通常のブリックとして機能します。

たとえば、gluster ボリューム 123 のブリックからデータの移行を停止するには、以下のように要求を送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.229 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

bricks

GlusterBrick[]

In

データ移行を停止する必要のあるブリックの一覧。

5.78.6.1. bricks
リンクのコピー

データ移行を停止する必要のあるブリックの一覧。この一覧は、migrate のために渡された引数と一致する必要があります。

5.79. GlusterHook
リンクのコピー

Expand
表5.230 メソッドの概要
Name概要

disable

クラスターの全サーバーで Gluster フックを無効にすることにより、クラスターのサーバー間でフックのステータスの競合を解決します。

enable

クラスターの全サーバーで Gluster フックを無効にすることにより、クラスターのサーバー間でフックのステータスの競合を解決します。

get

 

remove

クラスターのすべてのサーバーからこの Gluster フックを削除し、これをデータベースから削除します。

resolve

解決のタイプに応じて、不足しているフックの競合を解決します。

5.79.1. disable POST
リンクのコピー

クラスターの全サーバーで Gluster フックを無効にすることにより、クラスターのサーバー間でフックのステータスの競合を解決します。これにより、データベースでフックのステータスが DISABLED に更新されました。

Expand
表5.231 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.79.2. enable POST
リンクのコピー

クラスターの全サーバーで Gluster フックを無効にすることにより、クラスターのサーバー間でフックのステータスの競合を解決します。これにより、データベースでフックのステータスが DISABLED に更新されました。

Expand
表5.232 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.79.3. get GET
リンクのコピー

Expand
表5.233 パラメーターの概要
Nameタイプ方向概要

hook

GlusterHook

Out

 

5.79.4. remove DELETE
リンクのコピー

クラスターのすべてのサーバーからこの Gluster フックを削除し、これをデータベースから削除します。

Expand
表5.234 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.79.5. resolve POST
リンクのコピー

解決のタイプに応じて、不足しているフックの競合を解決します。

ADD の場合は、フックがないすべてのサーバーに、エンジンデータベースに保存されているフックをコピーして解決します。エンジンは、フックがないすべてのサーバーの一覧を維持します。

COPY の場合、フックが欠落しているすべてのサーバーにエンジンデータベースに保存されているフックをコピーして、フックの内容で競合を解決します。エンジンは、コンテンツが競合するサーバーの一覧を維持します。ホスト ID がパラメーターとして渡される場合、サーバーのフックコンテンツがマスターとして使用され、クラスター内の他のサーバーにコピーすることができます。

Expand
表5.235 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

host

ホスト

In

 

resolution_type

String

In

 

5.80. GlusterHooks
リンクのコピー

Expand
表5.236 メソッドの概要
Name概要

list

 

5.80.1. list GET
リンクのコピー

Expand
表5.237 パラメーターの概要
Nameタイプ方向概要

hooks

GlusterHook[]

Out

 

max

Integer

In

返すフックの最大数を設定します。

5.80.1.1. max
リンクのコピー

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

5.81. GlusterVolume
リンクのコピー

このサービスは単一の gluster ボリュームを管理します。

Expand
表5.238 メソッドの概要
Name概要

get

gluster ボリュームの詳細を取得します。

getprofilestatistics

gluster ボリュームプロファイルの統計を取得します。

rebalance

gluster ボリュームをリバランスします。

remove

gluster ボリュームを削除します。

resetalloptions

gluster ボリュームに設定されたすべてのオプションをリセットします。

resetoption

gluster ボリュームで特定のオプションをリセットします。

setoption

gluster ボリュームに特定のオプションを設定します。

start

gluster ボリュームを起動します。

startprofile

gluster ボリュームのプロファイリングを開始します。

stop

gluster ボリュームを停止します。

stopprofile

gluster ボリュームのプロファイリングを停止します。

stoprebalance

gluster ボリュームのリバランスを停止します。

5.81.1. get GET
リンクのコピー

gluster ボリュームの詳細を取得します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームの詳細を取得するには、以下のように要求を送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.239 パラメーターの概要
Nameタイプ方向概要

volume

GlusterVolume

Out

gluster ボリュームを表します。

5.81.2. getprofilestatistics POST
リンクのコピー

gluster ボリュームプロファイルの統計を取得します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームのプロファイル統計を取得するには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics
Copy to Clipboard Toggle word wrap
Expand
表5.240 パラメーターの概要
Nameタイプ方向概要

details

GlusterVolumeProfileDetails

Out

アクションから返される Gluster ボリュームのプロファイリング情報。

5.81.3. rebalance POST
リンクのコピー

gluster ボリュームをリバランスします。

gluster ボリュームのリバランスは、すべてのブリックにデータを均等に分散するのに役立ちます。(データの移行なし) gluster ボリュームを拡張または縮小した後、ブリック間でデータのリバランスを行う必要があります。複製されていないボリュームでは、リバランス操作を実行するために、すべてのブリックをオンラインにする必要があります。複製されたボリュームでは、レプリカ内の少なくとも 1 つのブリックがオンラインである必要があります。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームをリバランスするには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance
Copy to Clipboard Toggle word wrap
Expand
表5.241 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

リバランスを非同期的に実行するかどうかを指定します。

fix_layout

ブール値

In

true に設定すると、リバランスによってレイアウトが修正され、ボリュームに追加された新規データがすべてのホストに分散されます。

force

ブール値

In

リバランスを強制的に起動するかどうかを示します。

5.81.3.1. fix_layout
リンクのコピー

true に設定すると、リバランスによってレイアウトが修正され、ボリュームに追加された新規データがすべてのホストに分散されます。ただし、既存のデータは移行/リバランスされません。デフォルトは false です。

5.81.3.2. force
リンクのコピー

リバランスを強制的に起動するかどうかを示します。rebalance コマンドは、古いクライアントがクラスターに接続されている場合でも、force オプションを使用して実行できます。ただし、これにより、データが失われる可能性があります。デフォルトは false です。

5.81.4. remove DELETE
リンクのコピー

gluster ボリュームを削除します。

たとえば、クラスター 456 で識別子 123 のボリュームを削除するには、以下のように要求を送信します。 

DELETE /ovirt-engine/api/clusters/456/glustervolumes/123
Copy to Clipboard Toggle word wrap
Expand
表5.242 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.81.5. resetalloptions POST
リンクのコピー

gluster ボリュームに設定されたすべてのオプションをリセットします。

たとえば、クラスター 456 で識別子 123 を使用して gluster ボリューム内のすべてのオプションをリセットするには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions
Copy to Clipboard Toggle word wrap
Expand
表5.243 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

リセットを非同期で実行する必要があるかどうかを示します。

5.81.6. resetoption POST
リンクのコピー

gluster ボリュームで特定のオプションをリセットします。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームで特定の option1 をリセットするには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoption
Copy to Clipboard Toggle word wrap

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

<action>
 <option name="option1"/>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.244 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

リセットを非同期で実行する必要があるかどうかを示します。

force

ブール値

In

 

option

オプション

In

リセットするオプション。

5.81.7. setoption POST
リンクのコピー

gluster ボリュームに特定のオプションを設定します。

たとえば、クラスター 456 で識別子 123 で gluster ボリュームに option1 の値 value1 を設定するには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoption
Copy to Clipboard Toggle word wrap

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

<action>
 <option name="option1" value="value1"/>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.245 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

option

オプション

In

設定するオプション。

5.81.8. start POST
リンクのコピー

gluster ボリュームを起動します。

Gluster ボリュームは、データの読み取り/書き込みを開始する必要があります。たとえば、クラスター 456 で識別子 123 で gluster ボリュームを起動するには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/start
Copy to Clipboard Toggle word wrap
Expand
表5.246 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

force

ブール値

In

ボリュームが強制的に起動するかどうかを示します。

5.81.8.1. force
リンクのコピー

ボリュームが強制的に起動するかどうかを示します。gluster ボリュームがすでに開始されているが、いくつか/すべてのブリックがダウンしている場合は、強制開始を使用してすべてのブリックを起動できます。デフォルトは false です。

5.81.9. startprofile POST
リンクのコピー

gluster ボリュームのプロファイリングを開始します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームのプロファイリングを開始するには、以下のような要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile
Copy to Clipboard Toggle word wrap
Expand
表5.247 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.81.10. stop POST
リンクのコピー

gluster ボリュームを停止します。

ボリュームを停止すると、そのデータにはアクセスできなくなります。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームを停止するには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop
Copy to Clipboard Toggle word wrap
Expand
表5.248 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

force

ブール値

In

 

5.81.11. stopprofile POST
リンクのコピー

gluster ボリュームのプロファイリングを停止します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームのプロファイリングを停止するには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile
Copy to Clipboard Toggle word wrap
Expand
表5.249 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.81.12. stoprebalance POST
リンクのコピー

gluster ボリュームのリバランスを停止します。

たとえば、クラスター 456 で識別子 123 の gluster ボリュームの再調整を停止するには、以下のように要求を送信します。 

POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance
Copy to Clipboard Toggle word wrap
Expand
表5.250 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.82. GlusterVolumes
リンクのコピー

このサービスは、クラスターで利用可能な gluster ボリュームのコレクションを管理します。

Expand
表5.251 メソッドの概要
Name概要

add

新しい gluster ボリュームを作成します。

list

クラスター内のすべての gluster ボリュームを一覧表示します。

5.82.1. add POST
リンクのコピー

新しい gluster ボリュームを作成します。

ボリュームは、volume パラメーターのプロパティーに基づいて作成されます。プロパティー name、volume_type、および bricks が必要です。

たとえば、myvolume という名前のボリュームをクラスター 123 に追加するには、以下の要求を送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.252 パラメーターの概要
Nameタイプ方向概要

volume

GlusterVolume

In/Out

ボリュームを作成する gluster ボリュームの定義が入力として渡され、新規に作成されるボリュームが返されます。

5.82.2. list GET
リンクのコピー

クラスター内のすべての gluster ボリュームを一覧表示します。

たとえば、クラスター 456 のすべての Gluster ボリュームを一覧表示するには、以下のように要求を送信します。 

GET /ovirt-engine/api/clusters/456/glustervolumes
Copy to Clipboard Toggle word wrap
Expand
表5.253 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

max

Integer

In

返すボリュームの最大数を設定します。

search

String

In

返されたボリュームを制限するために使用されるクエリー文字列です。

volumes

GlusterVolume[]

Out

 
5.82.2.1. case_sensitive
リンクのコピー

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

5.82.2.2. max
リンクのコピー

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

5.83. GraphicsConsole
リンクのコピー

Expand
表5.254 メソッドの概要
Name概要

get

グラフィックコンソールの設定を取得します。

remove

 

5.83.1. get GET
リンクのコピー

グラフィックコンソールの設定を取得します。

Expand
表5.255 パラメーターの概要
Nameタイプ方向概要

console

GraphicsConsole

Out

 

current

ブール値

In

以下のクエリーを使用して、グラフィックコンソールの現在のランタイム設定を取得します。

5.83.1.1. current
リンクのコピー

以下のクエリーを使用して、グラフィックコンソールの現在のランタイム設定を取得します。 

GET /ovit-engine/api/vms/{vm:id}/graphicsconsoles/{console:id}?current=true
Copy to Clipboard Toggle word wrap

デフォルト値は false です。

5.83.2. remove DELETE
リンクのコピー

Expand
表5.256 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.84. GraphicsConsoles
リンクのコピー

Expand
表5.257 メソッドの概要
Name概要

add

 

list

仮想マシンの設定済みグラフィックコンソールをすべて一覧表示します。

5.84.1. add POST
リンクのコピー

Expand
表5.258 パラメーターの概要
Nameタイプ方向概要

console

GraphicsConsole

In/Out

 

5.84.2. list GET
リンクのコピー

仮想マシンの設定済みグラフィックコンソールをすべて一覧表示します。

Expand
表5.259 パラメーターの概要
Nameタイプ方向概要

consoles

GraphicsConsole[]

Out

 

current

ブール値

In

以下のクエリーを使用して、グラフィックコンソールの現在のランタイム設定を取得します。

max

Integer

In

返すコンソールの最大数を設定します。

5.84.2.1. current
リンクのコピー

以下のクエリーを使用して、グラフィックコンソールの現在のランタイム設定を取得します。 

GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true
Copy to Clipboard Toggle word wrap

デフォルト値は false です。

5.84.2.2. max
リンクのコピー

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

5.85. グループ
リンクのコピー

Expand
表5.260 メソッドの概要
Name概要

get

 

remove

 

5.85.1. get GET
リンクのコピー

Expand
表5.261 パラメーターの概要
Nameタイプ方向概要

get

グループ

Out

 

5.85.2. remove DELETE
リンクのコピー

Expand
表5.262 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.86. グループ
リンクのコピー

Expand
表5.263 メソッドの概要
Name概要

add

ディレクトリーサービスからグループを追加します。

list

 

5.86.1. add POST
リンクのコピー

ディレクトリーサービスからグループを追加します。ドメイン名は、認証プロバイダーの名前であることに注意してください。

たとえば、internal-authz 認証プロバイダーから Developers グループを追加するには、以下のような要求を送信します。 

POST /ovirt-engine/api/groups
Copy to Clipboard Toggle word wrap

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

<group>
  <name>Developers</name>
  <domain>
    <name>internal-authz</name>
  </domain>
</group>
Copy to Clipboard Toggle word wrap
Expand
表5.264 パラメーターの概要
Nameタイプ方向概要

group

グループ

In/Out

 

5.86.2. list GET
リンクのコピー

Expand
表5.265 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

groups

Group[]

Out

 

max

Integer

In

返すグループの最大数を設定します。

search

String

In

返されるグループを制限するために使用されるクエリー文字列。

5.86.2.1. case_sensitive
リンクのコピー

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

5.86.2.2. max
リンクのコピー

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

5.87. ホスト
リンクのコピー

ホストを管理するサービス

Expand
表5.266 メソッドの概要
Name概要

activate

仮想マシンの実行など、使用するホストをアクティブにします。

approve

仮想化環境で使用するために事前にインストールされたハイパーバイザーホストを承認します。

commitnetconfig

ネットワーク設定を正常としてマークし、ホスト内にその設定を持続させます。

deactivate

メンテナーンスタスクを実行するためにホストを無効にします。

enrollcertificate

ホストの証明書を登録します。

fence

ホストの電源管理デバイスを制御します。

forceselectspm

ホストをストレージプールマネージャー(SPM)として手動で設定します。

get

ホストの詳細を取得します。

install

VDSM と関連ソフトウェアをホストにインストールします。

iscsidiscover

イニシエーターの詳細を使用して、ホスト上の iSCSI ターゲットを検出します。

iscsilogin

ターゲットの詳細を使用して、ホストの iSCSI ターゲットにログインします。

refresh

ホストデバイスと機能を更新します。

remove

システムからホストを削除します。

setupnetworks

この方法は、ホストのネットワークインターフェイスの設定を変更するために使用されます。

unregisteredstoragedomainsdiscover

 

update

ホストのプロパティーを更新します。

upgrade

ホストで VDSM と選択したソフトウェアをアップグレードします。

5.87.1. activate POST
リンクのコピー

仮想マシンの実行など、使用するホストをアクティブにします。

Expand
表5.267 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクティベーションを非同期で実行する必要があるかどうかを示します。

5.87.2. approve POST
リンクのコピー

仮想化環境で使用するために事前にインストールされたハイパーバイザーホストを承認します。

このアクションは、このホストのターゲットクラスターを定義するためのオプションのクラスター要素も受け入れます。

Expand
表5.268 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

承認を非同期的に実行するかどうかを指定します。

cluster

Cluster

In

 

5.87.3. commitnetconfig POST
リンクのコピー

ネットワーク設定を正常としてマークし、ホスト内にその設定を持続させます。

API ユーザーは、ネットワーク設定をコミットして、ホストネットワークインターフェイスのアタッチメントまたはデタッチメントを永続化するか、ボンディングされたインターフェイスの作成と削除を永続化します。

重要

ネットワーク設定は、設定の変更によってホスト接続が失われないことをエンジンが確認した後にのみ、コミットされます。ホストの接続が失われた場合、ホストを再起動する必要があり、自動的に以前のネットワーク設定に戻ります。

たとえば、ID が 123 のホストのネットワーク設定をコミットするには、次のようなリクエストを送信します。 

POST /ovirt-engine/api/hosts/123/commitnetconfig
Copy to Clipboard Toggle word wrap

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

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.269 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.87.4. deactivate POST
リンクのコピー

メンテナーンスタスクを実行するためにホストを無効にします。

Expand
表5.270 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

非アクティブ化を非同期で実行する必要があるかどうかを示します。

reason

String

In

 

stop_gluster_service

ブール値

In

ホストの非アクティブ化の一環として gluster サービスを停止する必要があるかどうかを示します。

5.87.4.1. stop_gluster_service
リンクのコピー

ホストの非アクティブ化の一環として gluster サービスを停止する必要があるかどうかを示します。gluster ホストのメンテナーンス操作中に使用できます。この変数のデフォルト値は false です。

5.87.5. enrollcertificate POST
リンクのコピー

ホストの証明書を登録します。この警告が近づいている、またはすでに有効期限が切れているという警告が発生した場合に役に立ちます。

Expand
表5.271 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

登録を非同期で実行する必要があるかどうかを示します。

5.87.6. 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"
Copy to Clipboard Toggle word wrap
Expand
表5.272 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

フェンシングを非同期で実行する必要があるかどうかを示します。

fence_type

String

In

 

power_management

PowerManagement

Out

 

5.87.7. forceselectspm POST
リンクのコピー

ホストをストレージプールマネージャー(SPM)として手動で設定します。 

POST /ovirt-engine/api/hosts/123/forceselectspm
Copy to Clipboard Toggle word wrap

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

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.273 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.87.8. get GET
リンクのコピー

ホストの詳細を取得します。

Expand
表5.274 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

host

ホスト

Out

 

5.87.9. install POST
リンクのコピー

VDSM と関連ソフトウェアをホストにインストールします。ホストタイプは、アクションの追加パラメーターを定義します。

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"
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"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123?deploy_hosted_engine=true"
Copy to Clipboard Toggle word wrap
Expand
表5.275 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

インストールを非同期で実行する必要があるかどうかを示します。

deploy_hosted_engine

ブール値

In

true に設定すると、このホストもホスト型エンジンコンポーネントをデプロイする必要があることを意味します。

host

ホスト

In

この override_iptables プロパティーは、ファイアウォール設定をデフォルト設定に置き換える必要があるかどうかを示すために使用されます。

image

String

In

oVirt ノードのインストール時に、イメージの ISO ファイルが必要になります。

root_password

String

In

SSH 経由でホストに接続するために使用される root ユーザーのパスワード。

ssh

Ssh

In

ホストへの接続に使用される SSH の詳細。

undeploy_hosted_engine

ブール値

In

true に設定すると、このホストはホストエンジンコンポーネントをアンデプロイする必要があり、このホストは高可用性クラスターの一部として機能しません。

5.87.9.1. deploy_hosted_engine
リンクのコピー

true に設定すると、このホストもホスト型エンジンコンポーネントをデプロイする必要があることを意味します。欠落している値は true、つまりデプロイとして扱われます。このパラメーターを省略すると、false を意味し、ホスト型エンジン領域で操作を実行しません。

5.87.9.2. undeploy_hosted_engine
リンクのコピー

true に設定すると、このホストはホストエンジンコンポーネントをアンデプロイする必要があり、このホストは高可用性クラスターの一部として機能しません。欠落している値は true として扱われます。つまり、デプロイされていない省略は false を意味し、ホスト型エンジン領域で操作を実行しません。

5.87.10. iscsidiscover POST
リンクのコピー

イニシエーターの詳細を使用して、ホスト上の iSCSI ターゲットを検出します。

Expand
表5.276 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

検出を非同期で実行する必要があるかどうかを示します。

iscsi

IscsiDetails

In

ターゲット iSCSI デバイス。

iscsi_targets

String[]

Out

iSCSI ターゲット。

5.87.11. iscsilogin POST
リンクのコピー

ターゲットの詳細を使用して、ホストの iSCSI ターゲットにログインします。

Expand
表5.277 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

ログインを非同期で実行する必要があるかどうかを示します。

iscsi

IscsiDetails

In

ターゲット iSCSI デバイス。

5.87.12. refresh POST
リンクのコピー

ホストデバイスと機能を更新します。

Expand
表5.278 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

リフレッシュを非同期で実行する必要があるかどうかを示します。

5.87.13. 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"
Copy to Clipboard Toggle word wrap
Expand
表5.279 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.87.14. 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>
        <assignment_method>static</assignment_method>
        <ip_address_assignment>
          <ip>
            <address>192.168.122.10</address>
            <netmask>255.255.255.0</netmask>
          </ip>
        </ip_address_assignment>
      </ip_address_assignments>
    </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"/>
Copy to Clipboard Toggle word wrap

Python SDK を使用すると、以下のコードでも同じことができます。 

host.setupnetworks(
  params.Action(
    modified_bonds=params.HostNics(
      host_nic=[
        params.HostNIC(
          name="bond0",
          bonding=params.Bonding(
            options=params.Options(
              option=[
                params.Option(name="mode", value="4"),
                params.Option(name="miimon", value="100"),
              ],
            ),
            slaves=params.Slaves(
              host_nic=[
                params.HostNIC(name="eth1"),
                params.HostNIC(name="eth2"),
              ],
            ),
          ),
        ),
      ],
    ),
    modified_network_attachments=params.NetworkAttachments(
      network_attachment=[
        params.NetworkAttachment(
          network=params.Network(name="myvlan"),
          host_nic=params.HostNIC(name="bond0"),
          ip_address_assignments=params.IpAddressAssignments(
            ip_address_assignment=[
              params.IpAddressAssignment(
                assignment_method="static",
                ip=params.IP(
                  address="192.168.122.10",
                  netmask="255.255.255.0",
                ),
              ),
            ],
          ),
        ),
      ],
    ),
  ),
)
Copy to Clipboard Toggle word wrap
重要

ネットワーク設定がホストに保存されていること、およびホストの再起動時に適用されることを確認するには、commitnetconfig を呼び出すことを忘れないでください。

Expand
表5.280 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

check_connectivity

ブール値

In

 

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

 

5.87.15. unregisteredstoragedomainsdiscover POST
リンクのコピー

Expand
表5.281 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

検出を非同期で実行する必要があるかどうかを示します。

iscsi

IscsiDetails

In

 

storage_domains

StorageDomain[]

Out

 

5.87.16. update PUT
リンクのコピー

ホストのプロパティーを更新します。

たとえば、ホストのカーネルコマンドラインを更新するには、以下のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.282 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

host

ホスト

In/Out

 

5.87.17. upgrade POST
リンクのコピー

ホストで VDSM と選択したソフトウェアをアップグレードします。

Expand
表5.283 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アップグレードを非同期で実行する必要があるかどうかを示します。

5.88. HostDevice
リンクのコピー

ホストの特定のデバイスにアクセスするためのサービス。

Expand
表5.284 メソッドの概要
Name概要

get

特定のホストのデバイスに関する情報を取得します。

5.88.1. get GET
リンクのコピー

特定のホストのデバイスに関する情報を取得します。

ホストデバイスを取得する例: 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.285 パラメーターの概要
Nameタイプ方向概要

device

HostDevice

Out

 

5.89. HostDevices
リンクのコピー

ホストデバイスにアクセスするためのサービス。

Expand
表5.286 メソッドの概要
Name概要

list

ホストのデバイスを一覧表示します。

5.89.1. list GET
リンクのコピー

ホストのデバイスを一覧表示します。

Expand
表5.287 パラメーターの概要
Nameタイプ方向概要

devices

HostDevice[]

Out

 

max

Integer

In

返すデバイスの最大数を設定します。

5.89.1.1. max
リンクのコピー

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

5.90. HostHook
リンクのコピー

Expand
表5.288 メソッドの概要
Name概要

get

 

5.90.1. get GET
リンクのコピー

Expand
表5.289 パラメーターの概要
Nameタイプ方向概要

hook

Hook

Out

 

5.91. HostHooks
リンクのコピー

Expand
表5.290 メソッドの概要
Name概要

list

 

5.91.1. list GET
リンクのコピー

Expand
表5.291 パラメーターの概要
Nameタイプ方向概要

hooks

Hook[]

Out

 

max

Integer

In

返すフックの最大数を設定します。

5.91.1.1. max
リンクのコピー

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

5.92. HostNic
リンクのコピー

ホストのネットワークインターフェイスを管理するサービス。

Expand
表5.292 メソッドの概要
Name概要

get

 

updatevirtualfunctionsconfiguration

現在のリソースが SR-IOV 対応 NIC を表す場合、アクションは仮想機能設定を更新します。

5.92.1. get GET
リンクのコピー

Expand
表5.293 パラメーターの概要
Nameタイプ方向概要

nic

HostNic

Out

 

5.92.2. updatevirtualfunctionsconfiguration POST
リンクのコピー

現在のリソースが SR-IOV 対応 NIC を表す場合、アクションは仮想機能設定を更新します。入力は、以下のプロパティーの少なくとも 1 つで設定されている必要があります。

  • allNetworksAllowed
  • numberOfVirtualFunctions

プロパティーの意味については、HostNicVirtualFunctionsConfiguration タイプを参照してください。

Expand
表5.294 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

virtual_functions_configuration

HostNicVirtualFunctionsConfiguration

In

 

5.93. HostNics
リンクのコピー

ホストのネットワークインターフェイスを管理するサービス。

Expand
表5.295 メソッドの概要
Name概要

list

 

5.93.1. list GET
リンクのコピー

Expand
表5.296 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す NIC の最大数を設定します。

nics

HostNic[]

Out

 
5.93.1.1. max
リンクのコピー

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

5.94. HostNumaNode
リンクのコピー

Expand
表5.297 メソッドの概要
Name概要

get

 

5.94.1. get GET
リンクのコピー

Expand
表5.298 パラメーターの概要
Nameタイプ方向概要

node

NumaNode

Out

 

5.95. HostNumaNodes
リンクのコピー

Expand
表5.299 メソッドの概要
Name概要

list

 

5.95.1. list GET
リンクのコピー

Expand
表5.300 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すノードの最大数を設定します。

nodes

NumaNode[]

Out

 
5.95.1.1. max
リンクのコピー

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

5.96. HostStorage
リンクのコピー

ホストストレージを管理するサービス。

Expand
表5.301 メソッドの概要
Name概要

list

ストレージのリストを取得します。

5.96.1. list GET
リンクのコピー

ストレージのリストを取得します。 

GET /ovirt-engine/api/hosts/123/storage
Copy to Clipboard Toggle word wrap

取得する XML 応答は次のようになります。 

<host_storages>
  <host_storage id="123">
    ...
  </host_storage>
  ...
</host_storages>
Copy to Clipboard Toggle word wrap
Expand
表5.302 パラメーターの概要
Nameタイプ方向概要

report_status

ブール値

In

ストレージ内の LUN のステータスを確認する必要があるかどうかを示します。

storages

HostStorage[]

Out

ストレージのリストを取得しました。

5.96.1.1. 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>
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>
Copy to Clipboard Toggle word wrap

5.97. ホスト
リンクのコピー

ホストを管理するサービス。

Expand
表5.303 メソッドの概要
Name概要

add

新しいホストを作成します。

list

利用可能なすべてのホストのリストを取得します。

5.97.1. add POST
リンクのコピー

新しいホストを作成します。

ホストは、host パラメーターの属性に基づいて作成されます。名前、address プロパティー、および root_password プロパティーが必要です。

たとえば、ホストを追加するには、以下のリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
注記

root_password 要素は、クライアントが提供する初期表現にのみ含まれ、後続の要求から返される表現には公開されません。

ホスト型エンジンホストを追加するには、オプションの deploy_hosted_engine パラメーターを使用します。 

POST /ovirt-engine/api/hosts?deploy_hosted_engine=true
Copy to Clipboard Toggle word wrap
Expand
表5.304 パラメーターの概要
Nameタイプ方向概要

deploy_hosted_engine

ブール値

In

true に設定すると、このホストもホスト型エンジンコンポーネントをデプロイする必要があることを意味します。

host

ホスト

In/Out

新規ホストの作成元となるホスト定義がパラメーターとして渡され、新しく作成されたホストが返されます。

undeploy_hosted_engine

ブール値

In

true に設定すると、このホストはホストエンジンコンポーネントをアンデプロイする必要があり、このホストは高可用性クラスターの一部として機能しません。

5.97.1.1. deploy_hosted_engine
リンクのコピー

true に設定すると、このホストもホスト型エンジンコンポーネントをデプロイする必要があることを意味します。欠落している値は true、つまりデプロイとして扱われます。このパラメーターを省略すると、false を意味し、ホスト型エンジン領域で操作を実行しません。

5.97.1.2. undeploy_hosted_engine
リンクのコピー

true に設定すると、このホストはホストエンジンコンポーネントをアンデプロイする必要があり、このホストは高可用性クラスターの一部として機能しません。欠落している値は true （デプロイ解除）として処理されます。このパラメーターを省略すると、false を意味し、ホスト型エンジン領域で操作を実行しません。

5.97.2. list GET
リンクのコピー

利用可能なすべてのホストのリストを取得します。

たとえば、ホストを一覧表示するには、次のリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.305 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

filter

ブール値

In

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

hosts

Host[]

Out

 

max

Integer

In

返すホストの最大数を設定します。

search

String

In

返されたホストを制限するために使用されるクエリー文字列。

5.97.2.1. case_sensitive
リンクのコピー

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

5.97.2.2. max
リンクのコピー

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

5.98. アイコン
リンクのコピー

アイコンを管理するサービス (読み取り専用)。

Expand
表5.306 メソッドの概要
Name概要

get

アイコンを取得します。

5.98.1. get GET
リンクのコピー

アイコンを取得します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.307 パラメーターの概要
Nameタイプ方向概要

icon

アイコン

Out

取得したアイコン。

5.99. Icons
リンクのコピー

アイコンを管理するサービス。

Expand
表5.308 メソッドの概要
Name概要

list

アイコンのリストを取得します。

5.99.1. list GET
リンクのコピー

アイコンのリストを取得します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.309 パラメーターの概要
Nameタイプ方向概要

icons

icon[]

Out

アイコンのリストを取得しました。

max

Integer

In

返すアイコンの最大数を設定します。

5.99.1.1. max
リンクのコピー

返すアイコンの最大数を設定します。指定しない場合、すべてのアイコンが返されます。

5.100. Image
リンクのコピー

Expand
表5.310 メソッドの概要
Name概要

get

 

import

 

5.100.1. get GET
リンクのコピー

Expand
表5.311 パラメーターの概要
Nameタイプ方向概要

image

Image

Out

 

5.100.2. import POST
リンクのコピー

Expand
表5.312 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

インポートを非同期で実行する必要があるかどうかを示します。

cluster

Cluster

In

イメージをインポートする必要のあるクラスター。

disk

ディスク

In

インポートする必要のあるディスク。

import_as_template

ブール値

In

インポートしたディスクからテンプレートを作成するかどうかを指定します。

storage_domain

StorageDomain

In

ディスクをインポートする必要のあるストレージドメイン。

template

Template

In

作成するテンプレートの名前。

5.100.2.1. cluster
リンクのコピー

イメージをインポートする必要のあるクラスター。import_as_template パラメーターが true に設定されている場合にのみ有効になります。

5.100.2.2. template
リンクのコピー

作成するテンプレートの名前。import_as_template パラメーターが true に設定されている場合にのみ有効になります。

5.101. ImageTransfer
リンクのコピー

このサービスは、イメージ転送を制御するメカニズムを提供します。クライアントは、「ImageTransfers」 サービスの 追加 を使用して転送を作成し、データを転送するイメージを示す必要があります。

その後、転送はこのサービスによって管理されます。

たとえば、ID 52cb593f-837c-4633-a444-35a0a0383706 でディスクイメージにアップロードする場合、クライアントは以下のように oVirt の Python の SDK を使用できます。 

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      image=types.Image(
         id='52cb593f-837c-4633-a444-35a0a0383706'
      )
   )
)
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()
Copy to Clipboard Toggle word wrap

その段階で、転送のフェーズが paused_system である場合は、セッションが正常に確立されていないことになります。その原因として考えられるのは、転送対象として選択されたホストで ovirt-imageio-daemon が動作していないことです。転送は、それを管理するサービスの resume を呼び出すことによって再開できます。

セッションが正常に確立された場合：返される転送エンティティーには proxy_url および signed_ticket 属性が含まれます。これは、クライアントが必要なデータを転送するために使用する必要があります。クライアントは、イメージのデータで HTTPS 要求を送信するための手法およびツールを選択できます。

  • proxy_url は、I/O を行うイメージへのプロキシーサーバーのアドレスです。
  • signed_ticket は、信頼できる通信を実行するために HTTPS リクエストの Authentication ヘッダーに追加する必要があるコンテンツです。

たとえば、アップロードを実行するために Python の HTTPSConnection を使用すると、今後アップロード用に upload_headers dict が設定されます。 

upload_headers = {
   'Authorization' :  transfer.signed_ticket,
}
Copy to Clipboard Toggle word wrap

Python の HTTPSConnection を使用すると、新しい接続が確立されます。 

# Extract the URI, port, and path from the transfer's proxy_url.
url = urlparse(transfer.proxy_url)

# Create a new instance of the connection.
proxy_connection = HTTPSConnection(
   url.hostname,
   url.port,
   context=ssl.SSLContext(ssl.PROTOCOL_SSLv23)
)
Copy to Clipboard Toggle word wrap

送信される特定のコンテンツ範囲は、Content-Range HTTPS ヘッダーに記述する必要があります。これは、転送を複数のリクエストに分割し、より柔軟なプロセスを可能にするために使用できます。

これには、クライアントはチャネルを開いたままにするために転送セッションを繰り返し拡張する必要があります。そうしないと、セッションが終了し、転送は paused_system フェーズになり、サーバーへの HTTPS 要求は拒否されます。

たとえば、クライアントはファイルのチャンクを繰り返し処理し、サービスをセッションを拡張するように要求しながらプロキシーサーバーに送信できます。 

path = "/path/to/image"
MB_per_request = 32
with open(path, "rb") as disk:
   size = os.path.getsize(path)
   chunk_size = 1024*1024*MB_per_request
   pos = 0
   while (pos < size):
      transfer_service.extend()
      upload_headers['Content-Range'] = "bytes %d-%d/%d" % (pos, min(pos + chunk_size, size)-1, size)
      proxy_connection.request(
         'PUT',
         url.path,
         disk.read(chunk_size),
         headers=upload_headers
      )
      r = proxy_connection.getresponse()
      print r.status, r.reason, "Completed", "{:.0%}".format(pos/ float(size))
      pos += chunk_size
Copy to Clipboard Toggle word wrap

転送を終了すると、ユーザーは finalize を呼び出す必要があります。これにより、転送プロセスを完了する最終の調整と検証が行われます。

以下に例を示します。 

transfer_service.finalize()
Copy to Clipboard Toggle word wrap

エラーの場合は、転送のフェーズが finished_failure に変更され、ディスクのステータスが Illegal に変更されます。それ以外の場合は、finished_success に変更され、ディスクを使用する準備が整います。どちらの場合も、転送エンティティーはすぐに削除されます。

Expand
表5.313 メソッドの概要
Name概要

extend

イメージ転送セッションを延長します。

finalize

データの転送が終了したら、転送を完了します。

get

イメージ転送エンティティーを取得します。

pause

イメージ転送セッションを一時停止します。

再開

イメージ転送セッションを再開します。

5.101.1. extend POST
リンクのコピー

イメージ転送セッションを延長します。

5.101.2. finalize POST
リンクのコピー

データの転送が終了したら、転送を完了します。

これにより、転送されるデータが有効であり、転送の対象となったイメージエンティティーに適合していることが確認されます。具体的には、イメージエンティティーが QCOW ディスクの場合、アップロードされたデータが実際に QCOW ファイルであり、イメージにバッキングファイルがないことを確認します。

5.101.3. get GET
リンクのコピー

イメージ転送エンティティーを取得します。

Expand
表5.314 パラメーターの概要
Nameタイプ方向概要

image_transfer

ImageTransfer

Out

 

5.101.4. pause POST
リンクのコピー

イメージ転送セッションを一時停止します。

5.101.5. 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()
Copy to Clipboard Toggle word wrap

5.102. ImageTransfers
リンクのコピー

このサービスは、oVirt で Image I/O API を実行するためのイメージ転送を管理します。詳細は、イメージ転送 を参照してください。

Expand
表5.315 メソッドの概要
Name概要

add

新しいイメージ転送を追加します。

list

現在実行されているイメージ転送のリストを取得します。

5.102.1. add POST
リンクのコピー

新しいイメージ転送を追加します。新しい転送を行うには、イメージを指定する必要があります。

Expand
表5.316 パラメーターの概要
Nameタイプ方向概要

image_transfer

ImageTransfer

In/Out

 

5.102.2. list GET
リンクのコピー

現在実行されているイメージ転送のリストを取得します。

Expand
表5.317 パラメーターの概要
Nameタイプ方向概要

image_transfer

imagetransfer[]

Out

 

5.103. イメージ
リンクのコピー

Expand
表5.318 メソッドの概要
Name概要

list

 

5.103.1. list GET
リンクのコピー

Expand
表5.319 パラメーターの概要
Nameタイプ方向概要

images

Image[]

Out

 

max

Integer

In

返すイメージの最大数を設定します。

5.103.1.1. max
リンクのコピー

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

5.104. InstanceType
リンクのコピー

Expand
表5.320 メソッドの概要
Name概要

get

特定のインスタンスタイプとその属性を取得します。

remove

システムから特定のインスタンスタイプを削除します。

update

特定のインスタンスタイプとその属性を更新します。

5.104.1. get GET
リンクのコピー

特定のインスタンスタイプとその属性を取得します。 

GET /ovirt-engine/api/instancetypes/123
Copy to Clipboard Toggle word wrap
Expand
表5.321 パラメーターの概要
Nameタイプ方向概要

instance_type

InstanceType

Out

 

5.104.2. remove DELETE
リンクのコピー

システムから特定のインスタンスタイプを削除します。

インスタンスタイプの削除後にインスタンスタイプ X を使用して仮想マシンが作成された場合、仮想マシンのインスタンスタイプは custom に設定されます。 

DELETE /ovirt-engine/api/instancetypes/123
Copy to Clipboard Toggle word wrap
Expand
表5.322 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.104.3. update PUT
リンクのコピー

特定のインスタンスタイプとその属性を更新します。

すべての属性は、作成後に編集可能です。インスタンスタイプ X を使用して仮想マシンが作成され、インスタンスタイプ X の一部の設定が更新された場合、仮想マシンの設定はエンジンによって自動的に更新されます。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.323 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

instance_type

InstanceType

In/Out

 

5.105. InstanceTypeNic
リンクのコピー

Expand
表5.324 メソッドの概要
Name概要

get

インスタンスタイプのネットワークインターフェイス設定を取得します。

remove

インスタンスタイプからネットワークインターフェイスを削除します。

update

インスタンスタイプのネットワークインターフェイス設定を更新します。

5.105.1. get GET
リンクのコピー

インスタンスタイプのネットワークインターフェイス設定を取得します。

Expand
表5.325 パラメーターの概要
Nameタイプ方向概要

nic

Nic

Out

 

5.105.2. remove DELETE
リンクのコピー

インスタンスタイプからネットワークインターフェイスを削除します。

Expand
表5.326 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.105.3. update PUT
リンクのコピー

インスタンスタイプのネットワークインターフェイス設定を更新します。

Expand
表5.327 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

nic

Nic

In/Out

 

5.106. InstanceTypeNics
リンクのコピー

Expand
表5.328 メソッドの概要
Name概要

add

インスタンスタイプに新しいネットワークインターフェイスを追加します。

list

インスタンスタイプの設定済みネットワークインターフェイスをすべて一覧表示します。

5.106.1. add POST
リンクのコピー

インスタンスタイプに新しいネットワークインターフェイスを追加します。

Expand
表5.329 パラメーターの概要
Nameタイプ方向概要

nic

Nic

In/Out

 

5.106.2. list GET
リンクのコピー

インスタンスタイプの設定済みネットワークインターフェイスをすべて一覧表示します。

Expand
表5.330 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す NIC の最大数を設定します。

nics

Nic[]

Out

 

search

String

In

返されたボリュームを制限するために使用されるクエリー文字列です。

5.106.2.1. max
リンクのコピー

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

5.107. InstanceTypeWatchdog
リンクのコピー

Expand
表5.331 メソッドの概要
Name概要

get

インスタンスタイプのウォッチドッグ設定を取得します。

remove

インスタンスタイプからウォッチドッグを削除します。

update

インスタンスタイプのウォッチドッグ設定を更新します。

5.107.1. get GET
リンクのコピー

インスタンスタイプのウォッチドッグ設定を取得します。

Expand
表5.332 パラメーターの概要
Nameタイプ方向概要

watchdog

Watchdog

Out

 

5.107.2. remove DELETE
リンクのコピー

インスタンスタイプからウォッチドッグを削除します。

Expand
表5.333 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.107.3. update PUT
リンクのコピー

インスタンスタイプのウォッチドッグ設定を更新します。

Expand
表5.334 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

watchdog

Watchdog

In/Out

 

5.108. InstanceTypeWatchdogs
リンクのコピー

Expand
表5.335 メソッドの概要
Name概要

add

インスタンスタイプに新しいウォッチドッグを追加します。

list

インスタンスタイプの設定済みウォッチドッグをすべて一覧表示します。

5.108.1. add POST
リンクのコピー

インスタンスタイプに新しいウォッチドッグを追加します。

Expand
表5.336 パラメーターの概要
Nameタイプ方向概要

watchdog

Watchdog

In/Out

 

5.108.2. list GET
リンクのコピー

インスタンスタイプの設定済みウォッチドッグをすべて一覧表示します。

Expand
表5.337 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すウォッチドッグの最大数を設定します。

search

String

In

返されたボリュームを制限するために使用されるクエリー文字列です。

watchdogs

Watchdog[]

Out

 
5.108.2.1. max
リンクのコピー

返すウォッチドッグの最大数を設定します。指定しない場合、すべてのウォッチドッグが返されます。

5.109. InstanceTypes
リンクのコピー

Expand
表5.338 メソッドの概要
Name概要

add

新しいインスタンスタイプを作成します。

list

システム内の既存のすべてのインスタンスタイプを一覧表示します。

5.109.1. add POST
リンクのコピー

新しいインスタンスタイプを作成します。

これには name 属性のみが必要であり、仮想マシンのすべてのハードウェア設定を含めることができます。 

POST /ovirt-engine/api/instancetypes
Copy to Clipboard Toggle word wrap

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

<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>
Copy to Clipboard Toggle word wrap
Expand
表5.339 パラメーターの概要
Nameタイプ方向概要

instance_type

InstanceType

In/Out

 

5.109.2. list GET
リンクのコピー

システム内の既存のすべてのインスタンスタイプを一覧表示します。

Expand
表5.340 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

instance_type

InstanceType[]

Out

 

max

Integer

In

返すインスタンスタイプの最大数を設定します。

search

String

In

返されたボリュームを制限するために使用されるクエリー文字列です。

5.109.2.1. case_sensitive
リンクのコピー

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

5.109.2.2. max
リンクのコピー

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

5.110. IscsiBond
リンクのコピー

Expand
表5.341 メソッドの概要
Name概要

get

 

remove

既存の iSCSI ボンディングを削除します。

update

iSCSI ボンディングを更新します。

5.110.1. get GET
リンクのコピー

Expand
表5.342 パラメーターの概要
Nameタイプ方向概要

bond

IscsiBond

Out

 

5.110.2. remove DELETE
リンクのコピー

既存の iSCSI ボンディングを削除します。

たとえば、iSCSI ボンディング 456 を削除するには、次のようなリクエストを送信します。 

DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456
Copy to Clipboard Toggle word wrap
Expand
表5.343 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.110.3. update PUT
リンクのコピー

iSCSI ボンディングを更新します。

iSCSI ボンディングの更新は、name 属性と description 属性でのみ実行できます。たとえば、データセンター 123 の iSCSI ボンディング 456 を更新するには、次のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.344 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

bond

IscsiBond

In/Out

 

5.111. IscsiBonds
リンクのコピー

Expand
表5.345 メソッドの概要
Name概要

add

データセンターに新しい iSCSI ボンディングを作成します。

list

 

5.111.1. add POST
リンクのコピー

データセンターに新しい iSCSI ボンディングを作成します。

たとえば、ストレージ接続 456 および 789 を使用してデータセンター 123 に新しい iSCSI ボンディングを作成するには、以下のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.346 パラメーターの概要
Nameタイプ方向概要

bond

IscsiBond

In/Out

 

5.111.2. list GET
リンクのコピー

Expand
表5.347 パラメーターの概要
Nameタイプ方向概要

bonds

IscsiBond[]

Out

 

max

Integer

In

返すボンディングの最大数を設定します。

5.111.2.1. max
リンクのコピー

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

5.112. Job
リンクのコピー

ジョブを管理するサービス

Expand
表5.348 メソッドの概要
Name概要

clear

システムによってクリアされる外部ジョブの実行を設定します。

end

外部ジョブの実行を終了としてマークします。

get

ジョブを取得します。

5.112.1. clear POST
リンクのコピー

システムによってクリアされる外部ジョブの実行を設定します。

たとえば、識別子 123 でジョブを設定するには、次の要求を送信します。 

POST /ovirt-engine/api/jobs/clear
Copy to Clipboard Toggle word wrap

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

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.349 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.112.2. end POST
リンクのコピー

外部ジョブの実行を終了としてマークします。

たとえば、識別子 123 でジョブを終了するには、次の要求を送信します。 

POST /ovirt-engine/api/jobs/end
Copy to Clipboard Toggle word wrap

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

<action>
  <force>true</force>
  <status>finished</status>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.350 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

force

ブール値

In

ジョブを強制終了する必要があるかどうかを示します。

5.112.3. get GET
リンクのコピー

ジョブを取得します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.351 パラメーターの概要
Nameタイプ方向概要

job

Job

Out

ジョブの表現を取得します。

5.113. ジョブ
リンクのコピー

ジョブを管理するサービス。

Expand
表5.352 メソッドの概要
Name概要

add

外部ジョブを追加します。

list

ジョブの表現を取得します。

5.113.1. add POST
リンクのコピー

外部ジョブを追加します。

たとえば、次のリクエストでジョブを追加する場合で、 

POST /ovirt-engine/api/jobs
Copy to Clipboard Toggle word wrap

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

<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>
Copy to Clipboard Toggle word wrap
Expand
表5.353 パラメーターの概要
Nameタイプ方向概要

job

Job

In/Out

追加されるジョブ。

5.113.2. list GET
リンクのコピー

ジョブの表現を取得します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.354 パラメーターの概要
Nameタイプ方向概要

jobs

Job[]

Out

ジョブの表現。

max

Integer

In

返すジョブの最大数を設定します。

5.113.2.1. max
リンクのコピー

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

5.114. KatelloErrata
リンクのコピー

Katello エラータを管理するサービスです。この情報は Katello から取得されます。

Expand
表5.355 メソッドの概要
Name概要

list

Katello エラータの表現を取得します。

5.114.1. list GET
リンクのコピー

Katello エラータの表現を取得します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.356 パラメーターの概要
Nameタイプ方向概要

errata

KatelloErratum[]

Out

Katello エラータの表現。

max

Integer

In

返すエラータの最大数を設定します。

5.114.1.1. max
リンクのコピー

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

5.115. KatelloErratum
リンクのコピー

Katello エラータを管理するサービスです。

Expand
表5.357 メソッドの概要
Name概要

get

Katello エラータを取得します。

5.115.1. get GET
リンクのコピー

Katello エラータを取得します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.358 パラメーターの概要
Nameタイプ方向概要

erratum

KatelloErratum

Out

Katello エラータの表現を取得します。

5.116. MacPool
リンクのコピー

Expand
表5.359 メソッドの概要
Name概要

get

 

remove

MAC アドレスプールを削除します。

update

MAC アドレスプールを更新します。

5.116.1. get GET
リンクのコピー

Expand
表5.360 パラメーターの概要
Nameタイプ方向概要

pool

MacPool

Out

 

5.116.2. remove DELETE
リンクのコピー

MAC アドレスプールを削除します。

たとえば、ID が 123 の MAC アドレスプールを削除するには、次のようなリクエストを送信します。 

DELETE /ovirt-engine/api/macpools/123
Copy to Clipboard Toggle word wrap
Expand
表5.361 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.116.3. update PUT
リンクのコピー

MAC アドレスプールを更新します。

name、description、allow_duplicates、および ranges 属性を更新できます。

たとえば、ID 123 の MAC アドレスプールを更新するには、次のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.362 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

pool

MacPool

In/Out

 

5.117. MacPools
リンクのコピー

Expand
表5.363 メソッドの概要
Name概要

add

新しい MAC アドレスプールを作成します。

list

 

5.117.1. add POST
リンクのコピー

新しい MAC アドレスプールを作成します。

MAC アドレスプールを作成するには、name 属性と range 属性の値が必要です。

たとえば、MAC アドレスプールを作成するには、以下のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.364 パラメーターの概要
Nameタイプ方向概要

pool

MacPool

In/Out

 

5.117.2. list GET
リンクのコピー

Expand
表5.365 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプールの最大数を設定します。

pools

MacPool[]

Out

 
5.117.2.1. max
リンクのコピー

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

5.118. Measurable
リンクのコピー

5.119. Moveable
リンクのコピー

Expand
表5.366 メソッドの概要
Name概要

move

 

5.119.1. move POST
リンクのコピー

Expand
表5.367 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

移動を非同期で実行する必要があるかどうかを示します。

5.120. Network
リンクのコピー

ネットワークを管理するサービス

Expand
表5.368 メソッドの概要
Name概要

get

論理ネットワークを取得します。

remove

論理ネットワーク、または論理ネットワークのデータセンターへの関連付けを削除します。

update

論理ネットワークを更新します。

5.120.1. get GET
リンクのコピー

論理ネットワークを取得します。

以下に例を示します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.369 パラメーターの概要
Nameタイプ方向概要

network

Network

Out

 

5.120.2. remove DELETE
リンクのコピー

論理ネットワーク、または論理ネットワークのデータセンターへの関連付けを削除します。

たとえば、論理ネットワーク 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
Copy to Clipboard Toggle word wrap
Expand
表5.370 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.120.3. update PUT
リンクのコピー

論理ネットワークを更新します。

name、description、ip、vlan、stp、および display 属性を更新できます。

たとえば、論理ネットワーク 123 の説明を更新するには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/networks/123
Copy to Clipboard Toggle word wrap

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

<network>
  <description>My updated description</description>
</network>
Copy to Clipboard Toggle word wrap

ネットワークの最大伝送単位は、mtu 属性の整数値を指定する PUT 要求を使用して設定されます。

たとえば、最大伝送単位を設定するには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/datacenters/123/networks/456
Copy to Clipboard Toggle word wrap

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

<network>
  <mtu>1500</mtu>
</network>
Copy to Clipboard Toggle word wrap
Expand
表5.371 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

network

Network

In/Out

 

5.121. NetworkAttachment
リンクのコピー

Expand
表5.372 メソッドの概要
Name概要

get

 

remove

 

update

 

5.121.1. get GET
リンクのコピー

Expand
表5.373 パラメーターの概要
Nameタイプ方向概要

attachment

NetworkAttachment

Out

 

5.121.2. remove DELETE
リンクのコピー

Expand
表5.374 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.121.3. update PUT
リンクのコピー

Expand
表5.375 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

attachment

NetworkAttachment

In/Out

 

5.122. NetworkAttachments
リンクのコピー

Expand
表5.376 メソッドの概要
Name概要

add

 

list

 

5.122.1. add POST
リンクのコピー

Expand
表5.377 パラメーターの概要
Nameタイプ方向概要

attachment

NetworkAttachment

In/Out

 

5.122.2. list GET
リンクのコピー

Expand
表5.378 パラメーターの概要
Nameタイプ方向概要

attachments

NetworkAttachment[]

Out

 

max

Integer

In

返すアタッチメントの最大数を設定します。

5.122.2.1. max
リンクのコピー

返すアタッチメントの最大数を設定します。指定しない場合、すべてのアタッチメントが返されます。

5.123. 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>
Copy to Clipboard Toggle word wrap

バージョンは、特定のフィルターの最小サポートバージョンを参照することに注意してください。

Expand
表5.379 メソッドの概要
Name概要

get

ネットワークフィルターの表現を取得します。

5.123.1. get GET
リンクのコピー

ネットワークフィルターの表現を取得します。

Expand
表5.380 パラメーターの概要
Nameタイプ方向概要

network_filter

NetworkFilter

Out

 

5.124. NetworkFilters
リンクのコピー

読み取り専用のネットワークフィルターサブコレクションを表します。

ネットワークフィルターを使用すると、定義されたルールに従って、VM の nic との間で送受信されるパケットをフィルター処理できます。詳細は、NetworkFilter サービスドキュメントを参照してください。

ネットワークフィルターは、バージョン 3.0 以降、さまざまなバージョンでサポートされています。

ネットワークフィルターは、vnic プロファイルごとに定義されます。

vnic プロファイルは、特定のネットワークに対して定義されます。

ネットワークは、複数の異なるクラスターに割り当てることができます。将来的には、各ネットワークはクラスターレベルで定義されます。

現在、各ネットワークはデータセンターレベルで定義されています。各ネットワークの潜在的なネットワークフィルターは、ネットワークのデータセンター互換バージョン V によって決定されます。特定のネットワークに対してこのネットワークフィルターを設定するには、V がネットワークフィルターバージョン以上である必要があります。ネットワークフィルターをサポートするバージョンのクラスターにネットワークが割り当てられている場合、データセンターのバージョンがネットワークフィルターのバージョンより小さいため、フィルターを使用できない場合があることに注意してください。

特定のクラスターに対してサポートされているすべてのネットワークフィルターを一覧表示する例: 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.381 メソッドの概要
Name概要

list

ネットワークフィルターの表現を取得します。

5.124.1. list GET
リンクのコピー

ネットワークフィルターの表現を取得します。

Expand
表5.382 パラメーターの概要
Nameタイプ方向概要

filters

NetworkFilter[]

Out

 

5.125. NetworkLabel
リンクのコピー

Expand
表5.383 メソッドの概要
Name概要

get

 

remove

論理ネットワークからラベルを削除します。

5.125.1. get GET
リンクのコピー

Expand
表5.384 パラメーターの概要
Nameタイプ方向概要

label

NetworkLabel

Out

 

5.125.2. remove DELETE
リンクのコピー

論理ネットワークからラベルを削除します。

たとえば、ID 123 を持つ論理ネットワークからラベル exemplary を削除するには、以下の要求を送信します。 

DELETE /ovirt-engine/api/networks/123/labels/exemplary
Copy to Clipboard Toggle word wrap
Expand
表5.385 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.126. NetworkLabels
リンクのコピー

Expand
表5.386 メソッドの概要
Name概要

add

論理ネットワークにラベルをアタッチします。

list

 

5.126.1. add POST
リンクのコピー

論理ネットワークにラベルをアタッチします。

ラベルを論理ネットワークにアタッチして、その論理ネットワークと、同じラベルがアタッチされた物理ホストネットワークインターフェイスとの関連付けを自動化することができます。

たとえば、ラベル mylabel を ID 123 を持つ論理ネットワークにアタッチするには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/networks/123/labels
Copy to Clipboard Toggle word wrap

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

<label id="mylabel"/>
Copy to Clipboard Toggle word wrap
Expand
表5.387 パラメーターの概要
Nameタイプ方向概要

label

NetworkLabel

In/Out

 

5.126.2. list GET
リンクのコピー

Expand
表5.388 パラメーターの概要
Nameタイプ方向概要

labels

NetworkLabel[]

Out

 

max

Integer

In

返すラベルの最大数を設定します。

5.126.2.1. max
リンクのコピー

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

5.127. ネットワーク
リンクのコピー

論理ネットワークを管理します。

エンジンは、インストール時にデフォルトの ovirtmgmt ネットワークを作成します。このネットワークは、ハイパーバイザーホストにアクセスするための管理ネットワークとして機能します。このネットワークは Default クラスターに関連付けられており、Default データセンターのメンバーです。

Expand
表5.389 メソッドの概要
Name概要

add

新しい論理ネットワークを作成するか、既存のネットワークをデータセンターに関連付けます。

list

論理ネットワークを一覧表示します。

5.127.1. add POST
リンクのコピー

新しい論理ネットワークを作成するか、既存のネットワークをデータセンターに関連付けます。

新しいネットワークの作成には、name 要素と data_center 要素が必要です。

たとえば、データセンター 123 用に mynetwork という名前のネットワークを作成するには、以下のような要求を送信します。 

POST /ovirt-engine/api/networks
Copy to Clipboard Toggle word wrap

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

<network>
  <name>mynetwork</name>
  <data_center id="123"/>
</network>
Copy to Clipboard Toggle word wrap

既存のネットワーク 456 をデータセンター 123 に関連付けるには、以下のような要求を送信します。 

POST /ovirt-engine/api/datacenters/123/networks
Copy to Clipboard Toggle word wrap

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

<network>
  <name>ovirtmgmt</name>
</network>
Copy to Clipboard Toggle word wrap
Expand
表5.390 パラメーターの概要
Nameタイプ方向概要

network

Network

In/Out

 

5.127.2. list GET
リンクのコピー

論理ネットワークを一覧表示します。

以下に例を示します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.391 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

max

Integer

In

返すネットワークの最大数を設定します。

networks

Network[]

Out

 

search

String

In

返されたホストを制限するために使用されるクエリー文字列。

5.127.2.1. case_sensitive
リンクのコピー

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

5.127.2.2. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

5.128. OpenstackImage
リンクのコピー

Expand
表5.392 メソッドの概要
Name概要

get

 

import

Glance イメージストレージドメインから仮想マシンをインポートします。

5.128.1. get GET
リンクのコピー

Expand
表5.393 パラメーターの概要
Nameタイプ方向概要

image

OpenstackImage

Out

 

5.128.2. import POST
リンクのコピー

Glance イメージストレージドメインから仮想マシンをインポートします。

たとえば、識別子 123 のストレージドメインから識別子 456 のイメージをインポートするには、以下のような要求を送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.394 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

インポートを非同期で実行する必要があるかどうかを示します。

cluster

Cluster

In

このパラメーターは、import_as_template を使用する場合は必須であり、テンプレートとして glance イメージをインポートする際に使用するクラスターを示します。

disk

ディスク

In

 

import_as_template

ブール値

In

イメージをテンプレートとしてインポートする必要があるかどうかを示します。

storage_domain

StorageDomain

In

 

template

Template

In

 

5.129. OpenstackImageProvider
リンクのコピー

Expand
表5.395 メソッドの概要
Name概要

get

 

importcertificates

 

remove

 

testconnectivity

 

update

 

5.129.1. get GET
リンクのコピー

Expand
表5.396 パラメーターの概要
Nameタイプ方向概要

provider

OpenStackImageProvider

Out

 

5.129.2. importcertificates POST
リンクのコピー

Expand
表5.397 パラメーターの概要
Nameタイプ方向概要

certificates

Certificate[]

In

 

5.129.3. remove DELETE
リンクのコピー

Expand
表5.398 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.129.4. testconnectivity POST
リンクのコピー

Expand
表5.399 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

テストを非同期で実行する必要があるかどうかを示します。

5.129.5. update PUT
リンクのコピー

Expand
表5.400 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

provider

OpenStackImageProvider

In/Out

 

5.130. OpenstackImageProviders
リンクのコピー

Expand
表5.401 メソッドの概要
Name概要

add

 

list

 

5.130.1. add POST
リンクのコピー

Expand
表5.402 パラメーターの概要
Nameタイプ方向概要

provider

OpenStackImageProvider

In/Out

 

5.130.2. list GET
リンクのコピー

Expand
表5.403 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロバイダーの最大数を設定します。

providers

OpenStackImageProvider[]

Out

 
5.130.2.1. max
リンクのコピー

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

5.131. OpenstackImages
リンクのコピー

Expand
表5.404 メソッドの概要
Name概要

list

Glance イメージストレージドメインのイメージを一覧表示します。

5.131.1. list GET
リンクのコピー

Glance イメージストレージドメインのイメージを一覧表示します。

Expand
表5.405 パラメーターの概要
Nameタイプ方向概要

images

OpenStackImage[]

Out

 

max

Integer

In

返すイメージの最大数を設定します。

5.131.1.1. max
リンクのコピー

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

5.132. OpenstackNetwork
リンクのコピー

Expand
表5.406 メソッドの概要
Name概要

get

 

import

この操作は、外部ネットワークを oVirt にインポートします。

5.132.1. get GET
リンクのコピー

Expand
表5.407 パラメーターの概要
Nameタイプ方向概要

network

OpenStackNetwork

Out

 

5.132.2. import POST
リンクのコピー

この操作は、外部ネットワークを oVirt にインポートします。指定したデータセンターにネットワークが追加されます。

Expand
表5.408 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

インポートを非同期で実行する必要があるかどうかを示します。

data_center

DataCenter

In

ネットワークのインポート先のデータセンター。

5.132.2.1. data_center
リンクのコピー

ネットワークのインポート先のデータセンター。データセンターは必須であり、id または name 属性を使用して指定できます。残りの属性は無視されます。

5.133. OpenstackNetworkProvider
リンクのコピー

このサービスは、OpenStack ネットワークプロバイダーを管理します。

Expand
表5.409 メソッドの概要
Name概要

get

このサービスによって管理されるオブジェクトの表現を返します。

importcertificates

 

remove

プロバイダーを削除します。

testconnectivity

 

update

プロバイダーを更新します。

5.133.1. get GET
リンクのコピー

このサービスによって管理されるオブジェクトの表現を返します。

たとえば、識別子が 1234 の OpenStack ネットワークプロバイダーを取得するには、以下のようなリクエストを送信します。 

GET /ovirt-engine/api/openstacknetworkproviders/1234
Copy to Clipboard Toggle word wrap
Expand
表5.410 パラメーターの概要
Nameタイプ方向概要

provider

OpenStackNetworkProvider

Out

 

5.133.2. importcertificates POST
リンクのコピー

Expand
表5.411 パラメーターの概要
Nameタイプ方向概要

certificates

Certificate[]

In

 

5.133.3. remove DELETE
リンクのコピー

プロバイダーを削除します。

たとえば、識別子が 1234 の OpenStack ネットワークプロバイダーを削除するには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/openstacknetworkproviders/1234
Copy to Clipboard Toggle word wrap
Expand
表5.412 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.133.4. testconnectivity POST
リンクのコピー

Expand
表5.413 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

テストを非同期で実行する必要があるかどうかを示します。

5.133.5. update PUT
リンクのコピー

プロバイダーを更新します。

たとえば、識別子 1234 を持つ OpenStack ネットワークプロバイダーの provider_name、requires_authentication、url、tenant_name、および type プロパティーを更新するには、以下のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.414 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

provider

OpenStackNetworkProvider

In/Out

更新するプロバイダー。

5.134. OpenstackNetworkProviders
リンクのコピー

このサービスは、OpenStack ネットワークプロバイダーを管理します。

Expand
表5.415 メソッドの概要
Name概要

add

この操作により、新しいネットワークプロバイダーがシステムに追加されます。

list

 

5.134.1. add POST
リンクのコピー

この操作により、新しいネットワークプロバイダーがシステムに追加されます。type プロパティーが存在しない場合、デフォルト値の NEUTRON が使用されます。

Expand
表5.416 パラメーターの概要
Nameタイプ方向概要

provider

OpenStackNetworkProvider

In/Out

 

5.134.2. list GET
リンクのコピー

Expand
表5.417 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロバイダーの最大数を設定します。

providers

OpenStackNetworkProvider[]

Out

 
5.134.2.1. max
リンクのコピー

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

5.135. OpenstackNetworks
リンクのコピー

Expand
表5.418 メソッドの概要
Name概要

list

 

5.135.1. list GET
リンクのコピー

Expand
表5.419 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すネットワークの最大数を設定します。

networks

OpenStackNetwork[]

Out

 
5.135.1.1. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

5.136. OpenstackSubnet
リンクのコピー

Expand
表5.420 メソッドの概要
Name概要

get

 

remove

 

5.136.1. get GET
リンクのコピー

Expand
表5.421 パラメーターの概要
Nameタイプ方向概要

subnet

OpenStackSubnet

Out

 

5.136.2. remove DELETE
リンクのコピー

Expand
表5.422 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.137. OpenstackSubnets
リンクのコピー

Expand
表5.423 メソッドの概要
Name概要

add

 

list

 

5.137.1. add POST
リンクのコピー

Expand
表5.424 パラメーターの概要
Nameタイプ方向概要

subnet

OpenStackSubnet

In/Out

 

5.137.2. list GET
リンクのコピー

Expand
表5.425 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すサブネットワークの最大数を設定します。

subnets

OpenStackSubnet[]

Out

 
5.137.2.1. max
リンクのコピー

返すサブネットワークの最大数を設定します。指定されていない場合には、すべてのサブネットワークが返されます。

5.138. OpenstackVolumeAuthenticationKey
リンクのコピー

Expand
表5.426 メソッドの概要
Name概要

get

 

remove

 

update

 

5.138.1. get GET
リンクのコピー

Expand
表5.427 パラメーターの概要
Nameタイプ方向概要

key

OpenstackVolumeAuthenticationKey

Out

 

5.138.2. remove DELETE
リンクのコピー

Expand
表5.428 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.138.3. update PUT
リンクのコピー

Expand
表5.429 パラメーターの概要
Nameタイプ方向概要

key

OpenstackVolumeAuthenticationKey

In/Out

 

5.139. OpenstackVolumeAuthenticationKeys
リンクのコピー

Expand
表5.430 メソッドの概要
Name概要

add

 

list

 

5.139.1. add POST
リンクのコピー

Expand
表5.431 パラメーターの概要
Nameタイプ方向概要

key

OpenstackVolumeAuthenticationKey

In/Out

 

5.139.2. list GET
リンクのコピー

Expand
表5.432 パラメーターの概要
Nameタイプ方向概要

keys

OpenstackVolumeAuthenticationKey[]

Out

 

max

Integer

In

返すことのできるキーの最大数。

5.139.2.1. max
リンクのコピー

返すことのできるキーの最大数。指定されていない場合は、すべてのキーが返されます。

5.140. OpenstackVolumeProvider
リンクのコピー

Expand
表5.433 メソッドの概要
Name概要

get

 

importcertificates

 

remove

 

testconnectivity

 

update

 

5.140.1. get GET
リンクのコピー

Expand
表5.434 パラメーターの概要
Nameタイプ方向概要

provider

OpenStackVolumeProvider

Out

 

5.140.2. importcertificates POST
リンクのコピー

Expand
表5.435 パラメーターの概要
Nameタイプ方向概要

certificates

Certificate[]

In

 

5.140.3. remove DELETE
リンクのコピー

Expand
表5.436 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.140.4. testconnectivity POST
リンクのコピー

Expand
表5.437 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

テストを非同期で実行する必要があるかどうかを示します。

5.140.5. update PUT
リンクのコピー

Expand
表5.438 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

provider

OpenStackVolumeProvider

In/Out

 

5.141. OpenstackVolumeProviders
リンクのコピー

Expand
表5.439 メソッドの概要
Name概要

add

新しいボリュームプロバイダーを追加します。

list

ボリュームプロバイダーのリストを取得します。

5.141.1. add POST
リンクのコピー

新しいボリュームプロバイダーを追加します。

以下に例を示します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.440 パラメーターの概要
Nameタイプ方向概要

provider

OpenStackVolumeProvider

In/Out

 

5.141.2. list GET
リンクのコピー

ボリュームプロバイダーのリストを取得します。

Expand
表5.441 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロバイダーの最大数を設定します。

providers

OpenStackVolumeProvider[]

Out

 
5.141.2.1. max
リンクのコピー

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

5.142. OpenstackVolumeType
リンクのコピー

Expand
表5.442 メソッドの概要
Name概要

get

 

5.142.1. get GET
リンクのコピー

Expand
表5.443 パラメーターの概要
Nameタイプ方向概要

type

OpenStackVolumeType

Out

 

5.143. OpenstackVolumeTypes
リンクのコピー

Expand
表5.444 メソッドの概要
Name概要

list

 

5.143.1. list GET
リンクのコピー

Expand
表5.445 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すボリュームタイプの最大数を設定します。

types

OpenStackVolumeType[]

Out

 
5.143.1.1. max
リンクのコピー

返すボリュームタイプの最大数を設定します。指定されていない場合は、すべてのボリュームタイプが返されます。

5.144. OperatingSystem
リンクのコピー

Expand
表5.446 メソッドの概要
Name概要

get

 

5.144.1. get GET
リンクのコピー

Expand
表5.447 パラメーターの概要
Nameタイプ方向概要

operating_system

OperatingSystemInfo

Out

 

5.145. OperatingSystems
リンクのコピー

Expand
表5.448 メソッドの概要
Name概要

list

 

5.145.1. list GET
リンクのコピー

Expand
表5.449 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すネットワークの最大数を設定します。

operating_system

OperatingSystemInfo[]

Out

 
5.145.1.1. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

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

Expand
表5.450 メソッドの概要
Name概要

get

 

remove

 

5.146.1. get GET
リンクのコピー

Expand
表5.451 パラメーターの概要
Nameタイプ方向概要

permission

パーミッション

Out

 

5.146.2. remove DELETE
リンクのコピー

Expand
表5.452 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.147. Permit
リンクのコピー

ロールの特定の permit を管理するサービス。

Expand
表5.453 メソッドの概要
Name概要

get

ロールの permit に関する情報を取得します。

remove

ロールから permit を削除します。

5.147.1. get GET
リンクのコピー

ロールの permit に関する情報を取得します。

たとえば、ID 123 のロールの ID 456 の permit に関する情報を取得するには、以下のようなリクエストを送信します。 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.454 パラメーターの概要
Nameタイプ方向概要

permit

Permit

Out

ロールの permit。

5.147.2. remove DELETE
リンクのコピー

ロールから permit を削除します。

たとえば、ID 123 のロールから ID 456 の permit を削除するには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/roles/123/permits/456
Copy to Clipboard Toggle word wrap
Expand
表5.455 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.148. Permits
リンクのコピー

特定のロールの permits サブコレクションを表します。

Expand
表5.456 メソッドの概要
Name概要

add

ロールに permit を追加します。

list

ロールの permits を一覧表示します。

5.148.1. add POST
リンクのコピー

ロールに permit を追加します。permit 名は、「ClusterLevels」 サービスから取得できます。

たとえば、ID 123 のロールに permit create_vm を割り当てるには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/roles/123/permits
Copy to Clipboard Toggle word wrap

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

<permit>
  <name>create_vm</name>
</permit>
Copy to Clipboard Toggle word wrap
Expand
表5.457 パラメーターの概要
Nameタイプ方向概要

permit

Permit

In/Out

追加する permit。

5.148.2. list GET
リンクのコピー

ロールの permits を一覧表示します。

たとえば、ID 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>
Copy to Clipboard Toggle word wrap
Expand
表5.458 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す permits の最大数を設定します。

permits

Permit[]

Out

permits のリスト。

5.148.2.1. max
リンクのコピー

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

5.149. Qos
リンクのコピー

Expand
表5.459 メソッドの概要
Name概要

get

 

remove

 

update

 

5.149.1. get GET
リンクのコピー

Expand
表5.460 パラメーターの概要
Nameタイプ方向概要

qos

Qos

Out

 

5.149.2. remove DELETE
リンクのコピー

Expand
表5.461 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.149.3. update PUT
リンクのコピー

Expand
表5.462 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

qos

Qos

In/Out

 

5.150. Qoss
リンクのコピー

Expand
表5.463 メソッドの概要
Name概要

add

 

list

 

5.150.1. add POST
リンクのコピー

Expand
表5.464 パラメーターの概要
Nameタイプ方向概要

qos

Qos

In/Out

 

5.150.2. list GET
リンクのコピー

Expand
表5.465 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す QoS 記述子の最大数を設定します。

qoss

qos[]

Out

 
5.150.2.1. max
リンクのコピー

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

5.151. クォータ
リンクのコピー

Expand
表5.466 メソッドの概要
Name概要

get

クォータを取得します。

remove

クォータを削除します。

update

クォータを更新します。

5.151.1. get GET
リンクのコピー

クォータを取得します。

クォータを取得する例: 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.467 パラメーターの概要
Nameタイプ方向概要

quota

クォータ

Out

 

5.151.2. remove DELETE
リンクのコピー

クォータを削除します。

クォータを削除する例: 

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
表5.468 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.151.3. update PUT
リンクのコピー

クォータを更新します。

クォータを更新する例: 

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>
Copy to Clipboard Toggle word wrap
Expand
表5.469 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

quota

クォータ

In/Out

 

5.152. QuotaClusterLimit
リンクのコピー

Expand
表5.470 メソッドの概要
Name概要

get

 

remove

 

5.152.1. get GET
リンクのコピー

Expand
表5.471 パラメーターの概要
Nameタイプ方向概要

limit

QuotaClusterLimit

Out

 

5.152.2. remove DELETE
リンクのコピー

Expand
表5.472 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.153. QuotaClusterLimits
リンクのコピー

Expand
表5.473 メソッドの概要
Name概要

add

 

list

 

5.153.1. add POST
リンクのコピー

Expand
表5.474 パラメーターの概要
Nameタイプ方向概要

limit

QuotaClusterLimit

In/Out

 

5.153.2. list GET
リンクのコピー

Expand
表5.475 パラメーターの概要
Nameタイプ方向概要

limits

QuotaClusterLimit[]

Out

 

max

Integer

In

返す制限の最大数を設定します。

5.153.2.1. max
リンクのコピー

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

5.154. QuotaStorageLimit
リンクのコピー

Expand
表5.476 メソッドの概要
Name概要

get

 

remove

 

5.154.1. get GET
リンクのコピー

Expand
表5.477 パラメーターの概要
Nameタイプ方向概要

limit

QuotaStorageLimit

Out

 

5.154.2. remove DELETE
リンクのコピー

Expand
表5.478 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

5.155. QuotaStorageLimits
リンクのコピー

Expand
表5.479 メソッドの概要
Name概要

add

 

list

 

5.155.1. add POST
リンクのコピー

Expand
表5.480 パラメーターの概要
Nameタイプ方向概要

limit

QuotaStorageLimit

In/Out

 

5.155.2. list GET
リンクのコピー

Expand
表5.481 パラメーターの概要
Nameタイプ方向概要

limits

QuotaStorageLimit[]

Out

 

max

Integer

In

返す制限の最大数を設定します。

5.155.2.1. max
リンクのコピー

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

5.156. Quotas
リンクのコピー

Expand
表5.482 メソッドの概要
Name概要

add

新しいクォータを作成します。

list

データセンターのクォータを一覧表示します。

5.156.1. add POST
リンクのコピー

新しいクォータを作成します。

新しいクォータを作成する例: 

POST /ovirt-engine/api/datacenters/123/quotas
Copy to Clipboard Toggle word wrap 
<quota>
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
</quota>
Copy to Clipboard Toggle word wrap
Expand
表5.483 パラメーターの概要
Nameタイプ方向概要

quota

クォータ

In/Out

 

5.156.2. list GET
リンクのコピー

データセンターのクォータを一覧表示します。

Expand
表5.484 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すクォータ記述子の最大数を設定します。

quotas

Quota[]

Out

 
5.156.2.1. max
リンクのコピー

返すクォータ記述子の最大数を設定します。指定されていない場合は、すべての記述子が返されます。

5.157. ロール
リンクのコピー

Expand
表5.485 メソッドの概要
Name概要

get

ロールを取得します。

remove

ロールを削除します。

update

ロールを更新します。

5.157.1. get GET
リンクのコピー

ロールを取得します。 

GET /ovirt-engine/api/roles/123
Copy to Clipboard Toggle word wrap

以下のような XML 応答を受け取ります。 

<role id="123">
  <name>MyRole</name>
  <description>MyRole description</description>
  <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
  <administrative>true</administrative>
  <mutable>false</mutable>
</role>
Copy to Clipboard Toggle word wrap
Expand
表5.486 パラメーターの概要
Nameタイプ方向概要

role

ロール

Out

ロールを取得しました。

5.157.2. remove DELETE
リンクのコピー

ロールを削除します。

ロールを削除するには、その ID を知る必要があります。以下のようにリクエストを送信します。 

DELETE /ovirt-engine/api/roles/{role_id}
Copy to Clipboard Toggle word wrap
Expand
表5.487 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.157.3. update PUT
リンクのコピー

ロールを更新します。ロールの作成後に、name、description、および administrative 属性を更新できます。このエンドポイント内では、ロールの permits を管理する サービス を使用するために、必要なロールの permits を追加または削除することはできません。

たとえば、ロールの name、description、および administrative 属性を更新するには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/roles/123
Copy to Clipboard Toggle word wrap

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

<role>
  <name>MyNewRoleName</name>
  <description>My new description of the role</description>
  <administrative>true</administrative>
</group>
Copy to Clipboard Toggle word wrap
Expand
表5.488 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

role

ロール

In/Out

ロールを更新しました。

5.158. ロール
リンクのコピー

ロールのグローバルセットへの読み取り専用アクセスを提供します。

Expand
表5.489 メソッドの概要
Name概要

add

新規ロールを作成します。

list

ロールを一覧表示します。

5.158.1. add POST
リンクのコピー

新規ロールを作成します。ロールは、管理者または非管理者であることができ、異なる permits を持つことができます。

たとえば、ログインして仮想マシンを作成する permits を持つ MyRole 非管理ロールを追加するには、以下のようなリクエストを送信します (permit ID を渡す必要があることに注意してください)。 

POST /ovirt-engine/api/roles
Copy to Clipboard Toggle word wrap

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

<role>
  <name>MyRole</name>
  <description>My custom role to create virtual machines</description>
  <administrative>false</administrative>
  <permits>
    <permit id="1"/>
    <permit id="1300"/>
  </permits>
</group>
Copy to Clipboard Toggle word wrap
Expand
表5.490 パラメーターの概要
Nameタイプ方向概要

role

ロール

In/Out

追加されるロール。

5.158.2. list GET
リンクのコピー

ロールを一覧表示します。 

GET /ovirt-engine/api/roles
Copy to Clipboard Toggle word wrap

以下のような XML で応答を受け取ります。 

<roles>
  <role id="123">
     <name>SuperUser</name>
     <description>Roles management administrator</description>
     <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
     <administrative>true</administrative>
     <mutable>false</mutable>
  </role>
  ...
</roles>
Copy to Clipboard Toggle word wrap
Expand
表5.491 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すロールの最大数を設定します。

roles

Role[]

Out

ロールの一覧を取得しました。

5.158.2.1. max
リンクのコピー

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

5.159. SchedulingPolicies
リンクのコピー

Expand
表5.492 メソッドの概要
Name概要

add

 

list

 

5.159.1. add POST
リンクのコピー

Expand
表5.493 パラメーターの概要
Nameタイプ方向概要

policy

SchedulingPolicy

In/Out

 

5.159.2. list GET
リンクのコピー

Expand
表5.494 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

max

Integer

In

返すポリシーの最大数を設定します。

policies

SchedulingPolicy[]

Out

 
5.159.2.1. max
リンクのコピー

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

5.160. SchedulingPolicy
リンクのコピー

Expand
表5.495 メソッドの概要
Name概要

get

 

remove

 

update

 

5.160.1. get GET
リンクのコピー

Expand
表5.496 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

policy

SchedulingPolicy

Out

 

5.160.2. remove DELETE
リンクのコピー

Expand
表5.497 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.160.3. update PUT
リンクのコピー

Expand
表5.498 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

policy

SchedulingPolicy

In/Out

 

5.161. SchedulingPolicyUnit
リンクのコピー

Expand
表5.499 メソッドの概要
Name概要

get

 

remove

 

5.161.1. get GET
リンクのコピー

Expand
表5.500 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

unit

SchedulingPolicyUnit

Out

 

5.161.2. remove DELETE
リンクのコピー

Expand
表5.501 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.162. SchedulingPolicyUnits
リンクのコピー

Expand
表5.502 メソッドの概要
Name概要

list

 

5.162.1. list GET
リンクのコピー

Expand
表5.503 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

max

Integer

In

返すポリシーユニットの最大数を設定します。

units

SchedulingPolicyUnit[]

Out

 
5.162.1.1. max
リンクのコピー

返すポリシーユニットの最大数を設定します。指定されていない場合は、すべてのポリシーユニットが返されます。

5.163. スナップショット
リンクのコピー

Expand
表5.504 メソッドの概要
Name概要

get

 

remove

 

restore

仮想マシンのスナップショットを復元します。

5.163.1. get GET
リンクのコピー

Expand
表5.505 パラメーターの概要
Nameタイプ方向概要

snapshot

スナップショット

Out

 

5.163.2. remove DELETE
リンクのコピー

Expand
表5.506 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.163.3. restore POST
リンクのコピー

仮想マシンのスナップショットを復元します。

たとえば、識別子が 123 の仮想マシンの識別子が 456 のスナップショットを復元するには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/vms/123/snapshots/456/restore
Copy to Clipboard Toggle word wrap

ボディに空の action がある場合: 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.507 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

リセットを非同期で実行する必要があるかどうかを示します。

disks

Disk[]

In

 

restore_memory

ブール値

In

 

5.164. SnapshotCdrom
リンクのコピー

Expand
表5.508 メソッドの概要
Name概要

get

 

5.164.1. get GET
リンクのコピー

Expand
表5.509 パラメーターの概要
Nameタイプ方向概要

cdrom

Cdrom

Out

 

5.165. SnapshotCdroms
リンクのコピー

Expand
表5.510 メソッドの概要
Name概要

list

 

5.165.1. list GET
リンクのコピー

Expand
表5.511 パラメーターの概要
Nameタイプ方向概要

cdroms

Cdrom[]

Out

 

max

Integer

In

返す CDROM の最大数を設定します。

5.165.1.1. max
リンクのコピー

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

5.166. SnapshotDisk
リンクのコピー

Expand
表5.512 メソッドの概要
Name概要

get

 

5.166.1. get GET
リンクのコピー

Expand
表5.513 パラメーターの概要
Nameタイプ方向概要

disk

ディスク

Out

 

5.167. SnapshotDisks
リンクのコピー

Expand
表5.514 メソッドの概要
Name概要

list

 

5.167.1. list GET
リンクのコピー

Expand
表5.515 パラメーターの概要
Nameタイプ方向概要

disks

Disk[]

Out

 

max

Integer

In

返すディスクの最大数を設定します。

5.167.1.1. max
リンクのコピー

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

5.168. SnapshotNic
リンクのコピー

Expand
表5.516 メソッドの概要
Name概要

get

 

5.168.1. get GET
リンクのコピー

Expand
表5.517 パラメーターの概要
Nameタイプ方向概要

nic

Nic

Out

 

5.169. SnapshotNics
リンクのコピー

Expand
表5.518 メソッドの概要
Name概要

list

 

5.169.1. list GET
リンクのコピー

Expand
表5.519 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す NIC の最大数を設定します。

nics

Nic[]

Out

 
5.169.1.1. max
リンクのコピー

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

5.170. スナップショット
リンクのコピー

Expand
表5.520 メソッドの概要
Name概要

add

仮想マシンのスナップショットを作成します。

list

 

5.170.1. add POST
リンクのコピー

仮想マシンのスナップショットを作成します。

たとえば、仮想マシン 123 の新しいスナップショットを作成するには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/vms/123/snapshots
Copy to Clipboard Toggle word wrap

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

<snapshot>
  <description>My snapshot</description>
</snapshot>
Copy to Clipboard Toggle word wrap
Expand
表5.521 パラメーターの概要
Nameタイプ方向概要

snapshot

スナップショット

In/Out

 

5.170.2. list GET
リンクのコピー

Expand
表5.522 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すスナップショットの最大数を設定します。

snapshots

Snapshot[]

Out

 
5.170.2.1. max
リンクのコピー

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

5.171. SshPublicKey
リンクのコピー

Expand
表5.523 メソッドの概要
Name概要

get

 

remove

 

update

 

5.171.1. get GET
リンクのコピー

Expand
表5.524 パラメーターの概要
Nameタイプ方向概要

key

SshPublicKey

Out

 

5.171.2. remove DELETE
リンクのコピー

Expand
表5.525 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.171.3. update PUT
リンクのコピー

Expand
表5.526 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

key

SshPublicKey

In/Out

 

5.172. SshPublicKeys
リンクのコピー

Expand
表5.527 メソッドの概要
Name概要

add

 

list

 

5.172.1. add POST
リンクのコピー

Expand
表5.528 パラメーターの概要
Nameタイプ方向概要

key

SshPublicKey

In/Out

 

5.172.2. list GET
リンクのコピー

Expand
表5.529 パラメーターの概要
Nameタイプ方向概要

keys

SshPublicKey[]

Out

 

max

Integer

In

返すことのできるキーの最大数。

5.172.2.1. max
リンクのコピー

返すことのできるキーの最大数。指定されていない場合は、すべてのキーが返されます。

5.173. 統計
リンクのコピー

Expand
表5.530 メソッドの概要
Name概要

get

 

5.173.1. get GET
リンクのコピー

Expand
表5.531 パラメーターの概要
Nameタイプ方向概要

statistic

統計

In/Out

 

5.174. 統計
リンクのコピー

Expand
表5.532 メソッドの概要
Name概要

list

統計のリストを取得します。

5.174.1. list GET
リンクのコピー

統計のリストを取得します。

たとえば、仮想マシン 123 の統計を取得するには、以下のようなリクエストを送信します。 

GET /ovirt-engine/api/vms/123/statistics
Copy to Clipboard Toggle word wrap

結果は以下のようになります。 

<statistics>
  <statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
    <name>memory.installed</name>
    <description>Total memory configured</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>1073741824</datum>
      </value>
    </values>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </statistic>
  ...
</statistics>
Copy to Clipboard Toggle word wrap

URI の末尾に ID を指定することで、統計の一部のみを取得できます。つまり、以下のようになります。 

GET /ovirt-engine/api/vms/123/statistics/456
Copy to Clipboard Toggle word wrap

出力: 

<statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
  <name>memory.installed</name>
  <description>Total memory configured</description>
  <kind>gauge</kind>
  <type>integer</type>
  <unit>bytes</unit>
  <values>
    <value>
      <datum>1073741824</datum>
    </value>
  </values>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</statistic>
Copy to Clipboard Toggle word wrap
Expand
表5.533 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す統計の最大数を設定します。

statistics

Statistic[]

Out

 
5.174.1.1. max
リンクのコピー

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

5.175. Step
リンクのコピー

ステップを管理するサービス。

Expand
表5.534 メソッドの概要
Name概要

end

外部ステップの実行を終了としてマークします。

get

ステップを取得します。

5.175.1. end POST
リンクのコピー

外部ステップの実行を終了としてマークします。

たとえば、識別子 123 の job に属する識別子 456 のステップを終了するには、以下のリクエストを送信します。 

POST /ovirt-engine/api/jobs/123/steps/456/end
Copy to Clipboard Toggle word wrap

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

<action>
  <force>true</force>
  <succeeded>true</succeeded>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.535 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

force

ブール値

In

ステップを強制終了する必要があるかどうかを示します。

succeeded

ブール値

In

ステップ実行の解決を示します。

5.175.2. get GET
リンクのコピー

ステップを取得します。 

GET /ovirt-engine/api/jobs/123/steps/456
Copy to Clipboard Toggle word wrap

以下のような XML で応答を受け取ります。 

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <end_time>2016-12-12T23:07:26.627+02:00</end_time>
  <external>false</external>
  <number>0</number>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>finished</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>
Copy to Clipboard Toggle word wrap
Expand
表5.536 パラメーターの概要
Nameタイプ方向概要

step

Step

Out

ステップの表現を取得します。

5.176. Steps
リンクのコピー

ステップを管理するサービスです。

Expand
表5.537 メソッドの概要
Name概要

add

外部ステップを既存のジョブまたは既存のステップに追加します。

list

ステップの表現を取得します。

5.176.1. add POST
リンクのコピー

外部ステップを既存のジョブまたは既存のステップに追加します。

たとえば、識別子が 123 の job にステップを追加するには、以下のリクエストを送信します。 

POST /ovirt-engine/api/jobs/123/steps
Copy to Clipboard Toggle word wrap

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

<step>
  <description>Validating</description>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>started</status>
  <type>validating</type>
</step>
Copy to Clipboard Toggle word wrap

応答は以下のようになります。 

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
  <external>true</external>
  <number>2</number>
  <start_time>2016-12-13T01:06:15.380+02:00</start_time>
  <status>started</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>
Copy to Clipboard Toggle word wrap
Expand
表5.538 パラメーターの概要
Nameタイプ方向概要

step

Step

In/Out

追加されるステップ。

5.176.2. list GET
リンクのコピー

ステップの表現を取得します。 

GET /ovirt-engine/api/job/123/steps
Copy to Clipboard Toggle word wrap

以下のような XML で応答を受け取ります。 

<steps>
  <step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
    <actions>
      <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
    </actions>
    <description>Validating</description>
    <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
    <external>true</external>
    <number>2</number>
    <start_time>2016-12-13T01:06:15.380+02:00</start_time>
    <status>started</status>
    <type>validating</type>
    <job href="/ovirt-engine/api/jobs/123" id="123"/>
  </step>
  ...
</steps>
Copy to Clipboard Toggle word wrap
Expand
表5.539 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すステップの最大数を設定します。

steps

step[]

Out

ステップの表現。

5.176.2.1. max
リンクのコピー

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

5.177. ストレージ
リンクのコピー

Expand
表5.540 メソッドの概要
Name概要

get

 

5.177.1. get GET
リンクのコピー

Expand
表5.541 パラメーターの概要
Nameタイプ方向概要

report_status

ブール値

In

ストレージ内の LUN のステータスを確認する必要があるかどうかを示します。

storage

HostStorage

Out

 
5.177.1.1. report_status
リンクのコピー

ストレージ内の LUN のステータスを確認する必要があるかどうかを示します。LUN のステータスの確認は非常に重要な操作であり、このデータは必ずしもユーザーが必要とするものではありません。このパラメーターは、LUN のステータスチェックを実行しないオプションを提供します。

デフォルトは、後方互換性を確保するために true です。

LUN ステータスの例を次に示します。 

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>
Copy to Clipboard Toggle word wrap

これは、LUN ステータスのない例です。 

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>
Copy to Clipboard Toggle word wrap

5.178. StorageDomain
リンクのコピー

Expand
表5.542 メソッドの概要
Name概要

get

 

isattached

 

refreshluns

この操作により、LUN サイズが更新されます。

remove

ストレージドメインを削除します。

update

ストレージドメインを更新します。

updateovfstore

この操作により、このストレージドメインの OVF_STORE が強制的に更新されます。

5.178.1. get GET
リンクのコピー

Expand
表5.543 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

storage_domain

StorageDomain

Out

 

5.178.2. isattached POST
リンクのコピー

Expand
表5.544 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

host

ホスト

In

 

is_attached

ブール値

Out

 

5.178.3. refreshluns POST
リンクのコピー

この操作により、LUN サイズが更新されます。

ストレージサーバーの基盤となる LUN のサイズを増やした後、ユーザーは LUN サイズを更新できます。このアクションは、提供された LUN の再スキャンを強制し、必要に応じて新しいサイズでデータベースを更新します。

たとえば、2 つの LUN のサイズを更新するには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/storagedomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns
Copy to Clipboard Toggle word wrap

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

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>
Copy to Clipboard Toggle word wrap
Expand
表5.545 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

リフレッシュを非同期で実行する必要があるかどうかを示します。

logical_units

LogicalUnit[]

In

更新が必要な LUN。

5.178.4. remove DELETE
リンクのコピー

ストレージドメインを削除します。

特別なパラメーターがない場合、ストレージドメインはシステムから切り離され、データベースから削除されます。ストレージドメインは、同じまたは異なるセットアップに、すべてのデータを使用してインポートできます。ストレージにアクセスできない場合、操作は失敗します。

destroy パラメーターが true の場合、ストレージにアクセスできない場合でも操作は常に成功し、失敗は無視され、ストレージドメインはデータベースから削除されます。

format パラメーターが true の場合、実際のストレージがフォーマットされ、メタデータが LUN またはディレクトリーから削除されるため、同じセットアップまたは別のセットアップにインポートできなくなります。

Expand
表5.546 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

destroy

ブール値

In

ストレージにアクセスできない場合でも、操作が成功し、ストレージドメインがデータベースから削除されるかどうかを示します。

format

ブール値

In

実際のストレージをフォーマットし、基盤となる LUN またはディレクトリーからすべてのメタデータを削除するかどうかを示します。

[source] ---- DELETE /ovirt-engine/api/storagedomains/123?format=true ----

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

host

String

In

ストレージドメインの削除に使用するホストを示します。

5.178.4.1. destroy
リンクのコピー

ストレージにアクセスできない場合でも、操作が成功し、ストレージドメインがデータベースから削除されるかどうかを示します。 

DELETE /ovirt-engine/api/storagedomains/123?destroy=true
Copy to Clipboard Toggle word wrap

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

5.178.4.2. host
リンクのコピー

ストレージドメインの削除に使用するホストを示します。

このパラメーターは必須であり、ホストの名前または識別子を含めることができます。たとえば、myhost という名前のホストを使用して、識別子 123 のストレージドメインを削除するには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/storagedomains/123?host=myhost
Copy to Clipboard Toggle word wrap

5.178.5. update PUT
リンクのコピー

ストレージドメインを更新します。

StorageDomain の属性すべてが作成後に更新可能である訳ではありません。更新できるものは、name、description、comment、warning_low_space_indicator、critical_space_action_blocker、および wipe_after_delete です( wipe_after_delete 属性を変更しても、すでに存在するディスクの wipe after delete プロパティーは変更されません)。

識別子 123 を持つストレージドメインの name 属性と wipe_after_delete 属性を更新するには、以下のようにリクエストを送信する。 

PUT /ovirt-engine/api/storagedomains/123
Copy to Clipboard Toggle word wrap

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

<storage_domain>
  <name>data2</name>
  <wipe_after_delete>true</wipe_after_delete>
</storage_domain>
Copy to Clipboard Toggle word wrap
Expand
表5.547 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

storage_domain

StorageDomain

In/Out

 

5.178.6. updateovfstore POST
リンクのコピー

この操作により、このストレージドメインの OVF_STORE が強制的に更新されます。

OVF_STORE は、ストレージドメインにある仮想マシンとディスクのメタデータを含むディスクイメージです。このメタデータは、ドメインが別のデータセンターまたは別のインストールとの間でインポートまたはエクスポートされる場合に使用されます。

デフォルトでは、OVF_STORE は定期的に更新されますが (デフォルトでは 60 分に設定)、重要な変更後や OVF_STORE が破損していると思われる場合に、ユーザーは更新を強制する必要があることもあります。

ユーザーによって開始された場合、OVF_STORE 更新は、更新の必要性の有無にかかわらず実行されます。

Expand
表5.548 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

OVF_STORE 更新を非同期的に実行するかどうかを示します。

5.179. StorageDomainContentDisk
リンクのコピー

Expand
表5.549 メソッドの概要
Name概要

get

 

5.179.1. get GET
リンクのコピー

Expand
表5.550 パラメーターの概要
Nameタイプ方向概要

disk

ディスク

Out

 

filter

ブール値

In

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

5.180. StorageDomainContentDisks
リンクのコピー

Expand
表5.551 メソッドの概要
Name概要

list

 

5.180.1. list GET
リンクのコピー

Expand
表5.552 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

disks

Disk[]

Out

 

max

Integer

In

返すディスクの最大数を設定します。

search

String

In

返されたディスクを制限するために使用されるクエリー文字列。

5.180.1.1. case_sensitive
リンクのコピー

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

5.180.1.2. max
リンクのコピー

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

5.181. StorageDomainServerConnection
リンクのコピー

Expand
表5.553 メソッドの概要
Name概要

get

 

remove

ストレージ接続をストレージから切り離します。

5.181.1. get GET
リンクのコピー

Expand
表5.554 パラメーターの概要
Nameタイプ方向概要

connection

StorageConnection

Out

 

5.181.2. remove DELETE
リンクのコピー

ストレージ接続をストレージから切り離します。

Expand
表5.555 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.182. StorageDomainServerConnections
リンクのコピー

Expand
表5.556 メソッドの概要
Name概要

add

 

list

 

5.182.1. add POST
リンクのコピー

Expand
表5.557 パラメーターの概要
Nameタイプ方向概要

connection

StorageConnection

In/Out

 

5.182.2. list GET
リンクのコピー

Expand
表5.558 パラメーターの概要
Nameタイプ方向概要

connections

StorageConnection[]

Out

 

max

Integer

In

返す接続の最大数を設定します。

5.182.2.1. max
リンクのコピー

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

5.183. StorageDomainTemplate
リンクのコピー

Expand
表5.559 メソッドの概要
Name概要

get

 

import

 

register

 

remove

 

5.183.1. get GET
リンクのコピー

Expand
表5.560 パラメーターの概要
Nameタイプ方向概要

template

Template

Out

 

5.183.2. import POST
リンクのコピー

Expand
表5.561 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

インポートを非同期で実行する必要があるかどうかを示します。

clone

ブール値

In

 

cluster

Cluster

In

 

exclusive

ブール値

In

 

storage_domain

StorageDomain

In

 

template

Template

In

 

vm

Vm

In

 

5.183.3. register POST
リンクのコピー

Expand
表5.562 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

登録を非同期的に実行するかどうかを指定します。

clone

ブール値

In

 

cluster

Cluster

In

 

exclusive

ブール値

In

 

template

Template

In

 

5.183.4. remove DELETE
リンクのコピー

Expand
表5.563 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.184. StorageDomainTemplates
リンクのコピー

Expand
表5.564 メソッドの概要
Name概要

list

 

5.184.1. list GET
リンクのコピー

Expand
表5.565 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すテンプレートの最大数を設定します。

templates

Template[]

Out

 
5.184.1.1. max
リンクのコピー

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

5.185. StorageDomainVm
リンクのコピー

Expand
表5.566 メソッドの概要
Name概要

get

 

import

エクスポートストレージドメインから仮想マシンをインポートします。

register

 

remove

エクスポートストレージドメインから仮想マシンを削除します。

5.185.1. get GET
リンクのコピー

Expand
表5.567 パラメーターの概要
Nameタイプ方向概要

vm

Vm

Out

 

5.185.2. import POST
リンクのコピー

エクスポートストレージドメインから仮想マシンをインポートします。

たとえば、次のようなリクエストを送信します。 

POST /ovirt-engine/api/storagedomains/123/vms/456/import
Copy to Clipboard Toggle word wrap

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

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>
Copy to Clipboard Toggle word wrap

仮想マシンを新しいエンティティーとしてインポートするには、clone パラメーターを追加します。 

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <clone>true</clone>
  <vm>
    <name>myvm</name>
  </vm>
</action>
Copy to Clipboard Toggle word wrap

インポートするディスクを選択するために、オプションの disks パラメーターを含めます。たとえば、123 と 456 の識別子を持つテンプレートのディスクをインポートするには、以下のリクエスト本文を送信します。 

<action>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <vm>
    <name>myvm</name>
  </vm>
  <disks>
    <disk id="123"/>
    <disk id="456"/>
  </disks>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.568 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

インポートを非同期で実行する必要があるかどうかを示します。

clone

ブール値

In

インポートされた仮想マシンの識別子を再生成する必要があるかどうかを示します。

cluster

Cluster

In

 

collapse_snapshots

ブール値

In

スナップショットのない仮想マシンになるように、インポートされた仮想マシンのスナップショットを折りたたむ必要があることを示します。

storage_domain

StorageDomain

In

 

vm

Vm

In

 
5.185.2.1. clone
リンクのコピー

インポートされた仮想マシンの識別子を再生成する必要があるかどうかを示します。

デフォルトでは、仮想マシンがインポートされると、識別子が保持されます。つまり、識別子は一意である必要があるため、同じ仮想マシンを複数回インポートすることはできません。同じマシンを複数回インポートできるようにするには、このパラメーターを true に設定します。デフォルトは false です。

5.185.2.2. collapse_snapshots
リンクのコピー

スナップショットのない仮想マシンになるように、インポートされた仮想マシンのスナップショットを折りたたむ必要があることを示します。

このパラメーターはオプションであり、明示的に指定されていない場合、デフォルト値は false です。

5.185.3. register POST
リンクのコピー

Expand
表5.569 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

登録を非同期的に実行するかどうかを指定します。

clone

ブール値

In

 

cluster

Cluster

In

 

vm

Vm

In

 

5.185.4. remove DELETE
リンクのコピー

エクスポートストレージドメインから仮想マシンを削除します。

たとえば、仮想マシン 456 をストレージドメイン 123 から削除するには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/storagedomains/123/vms/456
Copy to Clipboard Toggle word wrap
Expand
表5.570 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.186. StorageDomainVmDiskAttachment
リンクのコピー

エクスポートドメイン内の仮想マシンにアタッチされているディスクの詳細を返します。

Expand
表5.571 メソッドの概要
Name概要

get

すべてのプロパティーとディスクへのリンクを含むアタッチメントの詳細を返します。

5.186.1. get GET
リンクのコピー

すべてのプロパティーとディスクへのリンクを含むアタッチメントの詳細を返します。

Expand
表5.572 パラメーターの概要
Nameタイプ方向概要

attachment

DiskAttachment

Out

ディスクアタッチメント。

5.187. StorageDomainVmDiskAttachments
リンクのコピー

エクスポートドメイン内の仮想マシンにアタッチされているディスクの詳細を返します。

Expand
表5.573 メソッドの概要
Name概要

list

仮想マシンに接続されているディスクを一覧表示します。

5.187.1. list GET
リンクのコピー

仮想マシンに接続されているディスクを一覧表示します。

Expand
表5.574 パラメーターの概要
Nameタイプ方向概要

attachments

DiskAttachment[]

Out

 

5.188. StorageDomainVms
リンクのコピー

エクスポートストレージドメインの仮想マシンを一覧表示します。

たとえば、識別子が 123 のストレージドメインで利用可能な仮想マシンを取得するには、以下のリクエストを送信します。 

GET /ovirt-engine/api/storagedomains/123/vms
Copy to Clipboard Toggle word wrap

これにより、以下のレスポンス本文が返されます。 

<vms>
  <vm id="456" href="/api/storagedomains/123/vms/456">
    <name>vm1</name>
    ...
    <storage_domain id="123" href="/api/storagedomains/123"/>
    <actions>
      <link rel="import" href="/api/storagedomains/123/vms/456/import"/>
    </actions>
  </vm>
</vms>
Copy to Clipboard Toggle word wrap

これらのコレクションの仮想マシンとテンプレートは、StorageDomain 参照と インポート アクションも含まれていることを除き、最上位の Vm コレクションと Template コレクションの対応するものと同様の表現をしています。

Expand
表5.575 メソッドの概要
Name概要

list

 

5.188.1. list GET
リンクのコピー

Expand
表5.576 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す仮想マシンの最大数を設定します。

vm

Vm[]

Out

 
5.188.1.1. max
リンクのコピー

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

5.189. StorageDomains
リンクのコピー

Expand
表5.577 メソッドの概要
Name概要

add

新しいストレージドメインを追加します。

list

 

5.189.1. add POST
リンクのコピー

新しいストレージドメインを追加します。

新しい StorageDomain を作成するには、名前、タイプ、ホスト、および ストレージ 属性が必要です。id または name 属性で host 属性を特定します。oVirt 3.6 以降では、ストレージドメインでデフォルトで削除後にワイプオプションを有効にできます。これを設定するには、POST 要求で wipe_after_delete を指定します。このオプションは、ドメインの作成後に編集することが可能ですが、その場合にはすでに存在していたディスクの削除後にワイププロパティーは変更されません。

指定の 名前、タイプ、storage.type、storage.address、storage. path、および ID 123 のホストを使用して新しいストレージドメインを追加するには、以下のように要求を送信します。 

POST /ovirt-engine/api/storagedomains
Copy to Clipboard Toggle word wrap

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

<storage_domain>
  <name>mydata</name>
  <type>data</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
Copy to Clipboard Toggle word wrap

新しい NFS ISO ストレージドメインを作成するには、次のような要求を送信します。 

<storage_domain>
  <name>myisos</name>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/export/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
Copy to Clipboard Toggle word wrap

新しい iSCSI ストレージドメインを作成するには、次のような要求を送信します。 

<storage_domain>
  <name>myiscsi</name>
  <type>data</type>
  <storage>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="3600144f09dbd050000004eedbd340001"/>
      <logical_unit id="3600144f09dbd050000004eedbd340002"/>
    </logical_units>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
Copy to Clipboard Toggle word wrap
Expand
表5.578 パラメーターの概要
Nameタイプ方向概要

storage_domain

StorageDomain

In/Out

 

5.189.2. list GET
リンクのコピー

Expand
表5.579 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

filter

ブール値

In

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

max

Integer

In

返すストレージドメインの最大数を設定します。

search

String

In

返されるストレージドメインを制限するために使用されるクエリー文字列。

storage_domains

StorageDomain[]

Out

 
5.189.2.1. case_sensitive
リンクのコピー

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

5.189.2.2. max
リンクのコピー

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

5.190. StorageServerConnection
リンクのコピー

Expand
表5.580 メソッドの概要
Name概要

get

 

remove

ストレージ接続を削除します。

update

ストレージ接続を更新します。

5.190.1. get GET
リンクのコピー

Expand
表5.581 パラメーターの概要
Nameタイプ方向概要

conection

StorageConnection

Out

 

5.190.2. remove DELETE
リンクのコピー

ストレージ接続を削除します。

ストレージ接続は、ストレージドメインも LUN ディスクも参照していない場合にのみ削除できます。ホスト名または ID はオプションです。それを提供すると、そのホストからの接続が切断 (アンマウント) されます。

Expand
表5.582 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

host

String

In

接続がアンマウント (切断) されるホストの名前または識別子。

5.190.2.1. host
リンクのコピー

接続がアンマウント (切断) されるホストの名前または識別子。指定しない場合、ホストは切断されません。

たとえば、識別子 456 のホストを使用して、識別子 123 のストレージ接続を削除するには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/storageconnections/123?host=456
Copy to Clipboard Toggle word wrap

5.190.3. update PUT
リンクのコピー

ストレージ接続を更新します。

たとえば、ストレージサーバーのアドレスを変更するには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/storageconnections/123
Copy to Clipboard Toggle word wrap

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

<storage_connection>
  <address>mynewnfs.example.com</address>
  <host>
    <name>myhost</name>
  </host>
</storage_connection>
Copy to Clipboard Toggle word wrap
Expand
表5.583 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

connection

StorageConnection

In/Out

 

force

ブール値

In

関連するストレージドメインのステータスに関係なく、操作が成功するかどうかを示します。

5.190.3.1. force
リンクのコピー

関連するストレージドメインのステータスに関係なく、操作が成功するかどうかを示します (つまり、ストレージドメインのステータスがメンテナーンスではない場合にも更新が適用されます)。

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

5.191. StorageServerConnectionExtension
リンクのコピー

Expand
表5.584 メソッドの概要
Name概要

get

 

remove

 

update

指定されたホストのストレージサーバー接続エクステンションを更新します。

5.191.1. get GET
リンクのコピー

Expand
表5.585 パラメーターの概要
Nameタイプ方向概要

extension

StorageConnectionExtension

Out

 

5.191.2. remove DELETE
リンクのコピー

Expand
表5.586 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.191.3. update PUT
リンクのコピー

指定されたホストのストレージサーバー接続エクステンションを更新します。

ホスト 123 のストレージ接続 456 を更新するには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456
Copy to Clipboard Toggle word wrap

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

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>
Copy to Clipboard Toggle word wrap
Expand
表5.587 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

extension

StorageConnectionExtension

In/Out

 

5.192. StorageServerConnectionExtensions
リンクのコピー

Expand
表5.588 メソッドの概要
Name概要

add

指定されたホストの新しいストレージサーバー接続エクステンションを作成します。

list

 

5.192.1. add POST
リンクのコピー

指定されたホストの新しいストレージサーバー接続エクステンションを作成します。

このエクステンションにより、ユーザーは特定のホストの iSCSI ターゲットのクレデンシャルを定義できます。たとえば、ホスト 123 から iSCSI ターゲットに接続するときに myuser および mypassword をクレデンシャルとして使用するには、次のような要求を送信します。 

POST /ovirt-engine/api/hosts/123/storageconnectionextensions
Copy to Clipboard Toggle word wrap

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

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>
Copy to Clipboard Toggle word wrap
Expand
表5.589 パラメーターの概要
Nameタイプ方向概要

extension

StorageConnectionExtension

In/Out

 

5.192.2. list GET
リンクのコピー

Expand
表5.590 パラメーターの概要
Nameタイプ方向概要

extensions

StorageConnectionExtension[]

Out

 

max

Integer

In

返すエクステンションの最大数を設定します。

5.192.2.1. max
リンクのコピー

返すエクステンションの最大数を設定します。指定されていない場合は、すべてのエクステンションが返されます。

5.193. StorageServerConnections
リンクのコピー

Expand
表5.591 メソッドの概要
Name概要

add

新しいストレージ接続を作成します。

list

 

5.193.1. add POST
リンクのコピー

新しいストレージ接続を作成します。

たとえば、NFS サーバー mynfs.example.com と NFS 共有 /export/mydata の新しいストレージ接続を作成するには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/storageconnections
Copy to Clipboard Toggle word wrap

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

<storage_connection>
  <type>nfs</type>
  <address>mynfs.example.com</address>
  <path>/export/mydata</path>
  <host>
    <name>myhost</name>
  </host>
</storage_connection>
Copy to Clipboard Toggle word wrap
Expand
表5.592 パラメーターの概要
Nameタイプ方向概要

connection

StorageConnection

In/Out

 

5.193.2. list GET
リンクのコピー

Expand
表5.593 パラメーターの概要
Nameタイプ方向概要

connections

StorageConnection[]

Out

 

max

Integer

In

返す接続の最大数を設定します。

5.193.2.1. max
リンクのコピー

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

5.194. システム
リンクのコピー

Expand
表5.594 メソッドの概要
Name概要

get

製品名、バージョン番号、関連オブジェクト数の概要など、API を説明する基本情報を返します。

reloadconfigurations

 

5.194.1. get GET
リンクのコピー

製品名、バージョン番号、関連オブジェクト数の概要など、API を説明する基本情報を返します。 

GET /ovirt-engine/api
Copy to Clipboard Toggle word wrap

次の応答が得られます。 

<api>
  <link rel="capabilities" href="/api/capabilities"/>
  <link rel="clusters" href="/api/clusters"/>
  <link rel="clusters/search" href="/api/clusters?search={query}"/>
  <link rel="datacenters" href="/api/datacenters"/>
  <link rel="datacenters/search" href="/api/datacenters?search={query}"/>
  <link rel="events" href="/api/events"/>
  <link rel="events/search" href="/api/events?search={query}"/>
  <link rel="hosts" href="/api/hosts"/>
  <link rel="hosts/search" href="/api/hosts?search={query}"/>
  <link rel="networks" href="/api/networks"/>
  <link rel="roles" href="/api/roles"/>
  <link rel="storagedomains" href="/api/storagedomains"/>
  <link rel="storagedomains/search" href="/api/storagedomains?search={query}"/>
  <link rel="tags" href="/api/tags"/>
  <link rel="templates" href="/api/templates"/>
  <link rel="templates/search" href="/api/templates?search={query}"/>
  <link rel="users" href="/api/users"/>
  <link rel="groups" href="/api/groups"/>
  <link rel="domains" href="/api/domains"/>
  <link rel="vmpools" href="/api/vmpools"/>
  <link rel="vmpools/search" href="/api/vmpools?search={query}"/>
  <link rel="vms" href="/api/vms"/>
  <link rel="vms/search" href="/api/vms?search={query}"/>
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>4</build>
      <full_version>4.0.4</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="/ovirt-engine/api/templates/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
    <root_tag href="/ovirt-engine/api/tags/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
  </special_objects>
  <summary>
    <hosts>
      <active>0</active>
      <total>0</total>
    </hosts>
    <storage_domains>
      <active>0</active>
      <total>1</total>
    </storage_domains>
    <users>
      <active>1</active>
      <total>1</total>
    </users>
    <vms>
      <active>0</active>
      <total>0</total>
    </vms>
  </summary>
  <time>2016-09-14T12:00:48.132+02:00</time>
</api>
Copy to Clipboard Toggle word wrap

エントリーポイントは、仮想化環境のコレクションへのリンクをユーザーに提供します。各コレクションリンクの rel 属性は、各リンクの参照ポイントを提供します。

エントリーポイントには、product_info、special_objects、および summary などの他のデータも含まれます。

Expand
表5.595 パラメーターの概要
Nameタイプ方向概要

api

Api

Out

 

5.194.2. reloadconfigurations POST
リンクのコピー

Expand
表5.596 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

リロードを非同期で実行する必要があるかどうかを示します。

5.195. SystemPermissions
リンクのコピー

このサービスは新しいメソッドを追加しません。これは、システムオブジェクトに割り当てられたパーミッションを管理するリソースのパスを指定するアノテーションのプレースホルダーに過ぎません。

Expand
表5.597 メソッドの概要
Name概要

add

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

list

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

5.195.1. add POST
リンクのコピー

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

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

POST /ovirt-engine/api/vms/123/permissions
Copy to Clipboard Toggle word wrap

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

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>
Copy to Clipboard Toggle word wrap

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

POST /ovirt-engine/api/permissions
Copy to Clipboard Toggle word wrap

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

<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
Copy to Clipboard Toggle word wrap

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

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>
Copy to Clipboard Toggle word wrap
Expand
表5.598 パラメーターの概要
Nameタイプ方向概要

permission

パーミッション

In/Out

パーミッション。

5.195.2. list GET
リンクのコピー

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

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

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>
Copy to Clipboard Toggle word wrap
Expand
表5.599 パラメーターの概要
Nameタイプ方向概要

permissions

Permission[]

Out

パーミッションのリスト

5.196. タグ
リンクのコピー

システム内の特定のタグを管理するサービス。

Expand
表5.600 メソッドの概要
Name概要

get

タグに関する情報を取得します。

remove

システムからタグを削除します。

update

タグエンティティーを更新します。

5.196.1. get GET
リンクのコピー

タグに関する情報を取得します。

たとえば、ID 123 のタグに関する情報を取得するには、以下のようなリクエストを送信します。 

GET /ovirt-engine/api/tags/123
Copy to Clipboard Toggle word wrap 
<tag href="/ovirt-engine/api/tags/123" id="123">
  <name>root</name>
  <description>root</description>
</tag>
Copy to Clipboard Toggle word wrap
Expand
表5.601 パラメーターの概要
Nameタイプ方向概要

tag

タグ

Out

タグ。

5.196.2. remove DELETE
リンクのコピー

システムからタグを削除します。

たとえば、ID 123 のタグを削除するには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/tags/123
Copy to Clipboard Toggle word wrap
Expand
表5.602 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.196.3. update PUT
リンクのコピー

タグエンティティーを更新します。

たとえば、親タグを ID 123 のタグの ID 456 のタグに更新するには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/tags/123
Copy to Clipboard Toggle word wrap

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

<tag>
  <parent id="456"/>
</tag>
Copy to Clipboard Toggle word wrap

ID の代わりにタグ名を指定することもできます。たとえば、親タグを ID 123 のタグの mytag という名前のタグに更新するには、以下のようなリクエストを送信します。 

<tag>
  <parent>
    <name>mytag</name>
  </parent>
</tag>
Copy to Clipboard Toggle word wrap
Expand
表5.603 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

tag

タグ

In/Out

更新されたタグ。

5.197. タグ
リンクのコピー

システム内のタグのコレクションを管理するサービスを表します。

Expand
表5.604 メソッドの概要
Name概要

add

システムに新しいタグを追加します。

list

システム内のタグを一覧表示します。

5.197.1. add POST
リンクのコピー

システムに新しいタグを追加します。

たとえば、mytag という名前の新しいタグをシステムに追加するには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/tags
Copy to Clipboard Toggle word wrap

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

<tag>
  <name>mytag</name>
</tag>
Copy to Clipboard Toggle word wrap
注記

root タグは、親タグが指定されていない場合にデフォルトの親タグと見なされる特別な疑似タグになります。root タグを削除したり、親タグを割り当てたりすることはできません。

特定の親タグを持つ新しいタグを作成するには、以下のようなリクエスト本文を送信します。 

<tag>
  <name>mytag</name>
  <parent>
    <name>myparenttag</name>
  </parent>
</tag>
Copy to Clipboard Toggle word wrap
Expand
表5.605 パラメーターの概要
Nameタイプ方向概要

tag

タグ

In/Out

追加されたタグ。

5.197.2. list GET
リンクのコピー

システム内のタグを一覧表示します。

たとえば、システム内のタグの完全な階層を一覧表示するには、以下のようなリクエストを送信します。 

GET /ovirt-engine/api/tags
Copy to Clipboard Toggle word wrap 
<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>root2</name>
    <description>root2</description>
    <parent href="/ovirt-engine/api/tags/111" id="111"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/333" id="333">
    <name>root3</name>
    <description>root3</description>
    <parent href="/ovirt-engine/api/tags/222" id="222"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/111" id="111">
    <name>root</name>
    <description>root</description>
  </tag>
</tags>
Copy to Clipboard Toggle word wrap

前の XML 出力では、以下のようなタグの階層を確認できます。 

root:        (id: 111)
  - root2    (id: 222)
    - root3  (id: 333)
Copy to Clipboard Toggle word wrap
Expand
表5.606 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すタグの最大数を設定します。

tags

Tag[]

Out

システム内のすべてのタグの一覧。

5.197.2.1. max
リンクのコピー

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

5.198. Template
リンクのコピー

仮想マシンのテンプレートとテンプレートのバージョンを管理します。

Expand
表5.607 メソッドの概要
Name概要

export

テンプレートをデータセンターのエクスポートドメインにエクスポートします。

get

このテンプレートまたはテンプレートバージョンに関する情報を返します。

remove

仮想マシンテンプレートを削除します。

update

テンプレートを更新します。

5.198.1. export POST
リンクのコピー

テンプレートをデータセンターのエクスポートドメインにエクスポートします。

たとえば、以下のリクエストを使用すると操作が容易になります。 

POST /ovirt-engine/api/templates/123/export
Copy to Clipboard Toggle word wrap

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

<action>
  <storage_domain id="456"/>
  <exclusive>true<exclusive/>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.608 パラメーターの概要
Nameタイプ方向概要

exclusive

ブール値

In

同じ名前の既存のテンプレートを上書きする必要があるかどうかを示します。

storage_domain

StorageDomain

In

宛先のエクスポートストレージドメインを指定します。

5.198.1.1. exclusive
リンクのコピー

同じ名前の既存のテンプレートを上書きする必要があるかどうかを示します。

宛先ドメインに同じ名前のテンプレートが存在する場合、エクスポートアクションは失敗したアクションを報告します。このパラメーターを true に設定すると、この動作が変更され、既存のテンプレートがすべて上書きされます。

5.198.2. get GET
リンクのコピー

このテンプレートまたはテンプレートバージョンに関する情報を返します。

Expand
表5.609 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

template

Template

Out

テンプレートまたはテンプレートバージョンに関する情報。

5.198.3. remove DELETE
リンクのコピー

仮想マシンテンプレートを削除します。 

DELETE /ovirt-engine/api/templates/123
Copy to Clipboard Toggle word wrap
Expand
表5.610 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.198.4. update PUT
リンクのコピー

テンプレートを更新します。

名前、説明、タイプ、メモリー、CPU、 トポロジー、os、high_availability、display、stateless、usb、および timezone 要素は、テンプレートの作成後に更新できます。

たとえば、1 GiB のメモリーを持つようにテンプレートを更新するには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/templates/123
Copy to Clipboard Toggle word wrap

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

<template>
  <memory>1073741824</memory>
</template>
Copy to Clipboard Toggle word wrap

version_name name 属性は、テンプレートバージョンに使用される version 属性内で更新できる唯一の属性です。 

<template>
  <version>
    <version_name>mytemplate_2</version_name>
  </version>
</template>
Copy to Clipboard Toggle word wrap
Expand
表5.611 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

template

Template

In/Out

 

5.199. TemplateCdrom
リンクのコピー

テンプレートで CD-ROM デバイスを管理するサービス。

Expand
表5.612 メソッドの概要
Name概要

get

この CDROM デバイスに関する情報を返します。

5.199.1. get GET
リンクのコピー

この CDROM デバイスに関する情報を返します。

たとえば、テンプレート 123 の CD-ROM デバイスに関する情報を取得するには、以下のようなリクエストを送信します。 

GET /ovirt-engine/api/templates/123/cdroms/
Copy to Clipboard Toggle word wrap
Expand
表5.613 パラメーターの概要
Nameタイプ方向概要

cdrom

Cdrom

Out

CDROM デバイスに関する情報。

5.199.1.1. cdrom
リンクのコピー

CDROM デバイスに関する情報。

情報は、CD-ROM デバイス、テンプレート、およびオプションで挿入されたディスクへの参照を含む cdrom 属性で設定されています。

ディスクが挿入されている場合は、file 属性には ISO イメージへの参照が含まれます。 

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
  <file id="mycd.iso"/>
</cdrom>
Copy to Clipboard Toggle word wrap

ディスクが挿入されていない場合は、file 属性は報告されません。 

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
</cdrom>
Copy to Clipboard Toggle word wrap

5.200. TemplateCdroms
リンクのコピー

テンプレートの CD-ROM デバイスを一覧表示します。

Expand
表5.614 メソッドの概要
Name概要

list

 

5.200.1. list GET
リンクのコピー

Expand
表5.615 パラメーターの概要
Nameタイプ方向概要

cdroms

Cdrom[]

Out

テンプレートの CD-ROM デバイスの一覧。

max

Integer

In

返す CD-ROM の最大数を設定します。

5.200.1.1. max
リンクのコピー

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

5.201. TemplateDisk
リンクのコピー

Expand
表5.616 メソッドの概要
Name概要

copy

 

export

 

get

 

remove

 

5.201.1. copy POST
リンクのコピー

Expand
表5.617 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

コピーを非同期的に実行するかどうかを指定します。

filter

ブール値

In

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

5.201.2. export POST
リンクのコピー

Expand
表5.618 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

エクスポートを非同期で実行する必要があるかどうかを示します。

filter

ブール値

In

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

5.201.3. get GET
リンクのコピー

Expand
表5.619 パラメーターの概要
Nameタイプ方向概要

disk

ディスク

Out

 

5.201.4. remove DELETE
リンクのコピー

Expand
表5.620 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.202. TemplateDiskAttachment
リンクのコピー

このサービスは、テンプレートへのディスクの割り当てを管理します。

Expand
表5.621 メソッドの概要
Name概要

get

アタッチメントの詳細を返します。

remove

テンプレートからディスクを削除します。

5.202.1. get GET
リンクのコピー

アタッチメントの詳細を返します。

Expand
表5.622 パラメーターの概要
Nameタイプ方向概要

attachment

DiskAttachment

Out

 

5.202.2. remove DELETE
リンクのコピー

テンプレートからディスクを削除します。ディスクは、他のストレージドメインにディスクのコピーが存在する場合にのみ削除されます。

どのコピーを削除するかを決定するには、ストレージドメインを指定する必要があります (テンプレートディスクは複数のストレージドメインにコピーを持つことができます)。 

DELETE /ovirt-engine/api/templates/{template:id}/diskattachments/{attachment:id}?storage_domain=072fbaa1-08f3-4a40-9f34-a5ca22dd1d74
Copy to Clipboard Toggle word wrap
Expand
表5.623 パラメーターの概要
Nameタイプ方向概要

force

ブール値

In

 

storage_domain

String

In

削除するイメージが存在するストレージドメインの識別子を指定します。

5.203. TemplateDiskAttachments
リンクのコピー

このサービスは、テンプレートに割り当てられた一連のディスクを管理します。アタッチされた各ディスクは、DiskAttachment で表されます。

Expand
表5.624 メソッドの概要
Name概要

list

テンプレートにアタッチされているディスクを一覧表示します。

5.203.1. list GET
リンクのコピー

テンプレートにアタッチされているディスクを一覧表示します。

Expand
表5.625 パラメーターの概要
Nameタイプ方向概要

attachments

DiskAttachment[]

Out

 

5.204. TemplateDisks
リンクのコピー

Expand
表5.626 メソッドの概要
Name概要

list

 

5.204.1. list GET
リンクのコピー

Expand
表5.627 パラメーターの概要
Nameタイプ方向概要

disks

Disk[]

Out

 

max

Integer

In

返すディスクの最大数を設定します。

5.204.1.1. max
リンクのコピー

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

5.205. TemplateNic
リンクのコピー

Expand
表5.628 メソッドの概要
Name概要

get

 

remove

 

update

 

5.205.1. get GET
リンクのコピー

Expand
表5.629 パラメーターの概要
Nameタイプ方向概要

nic

Nic

Out

 

5.205.2. remove DELETE
リンクのコピー

Expand
表5.630 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.205.3. update PUT
リンクのコピー

Expand
表5.631 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

nic

Nic

In/Out

 

5.206. TemplateNics
リンクのコピー

Expand
表5.632 メソッドの概要
Name概要

add

 

list

 

5.206.1. add POST
リンクのコピー

Expand
表5.633 パラメーターの概要
Nameタイプ方向概要

nic

Nic

In/Out

 

5.206.2. list GET
リンクのコピー

Expand
表5.634 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す NIC の最大数を設定します。

nics

Nic[]

Out

 
5.206.2.1. max
リンクのコピー

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

5.207. TemplateWatchdog
リンクのコピー

Expand
表5.635 メソッドの概要
Name概要

get

 

remove

 

update

 

5.207.1. get GET
リンクのコピー

Expand
表5.636 パラメーターの概要
Nameタイプ方向概要

watchdog

Watchdog

Out

 

5.207.2. remove DELETE
リンクのコピー

Expand
表5.637 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.207.3. update PUT
リンクのコピー

Expand
表5.638 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

watchdog

Watchdog

In/Out

 

5.208. TemplateWatchdogs
リンクのコピー

Expand
表5.639 メソッドの概要
Name概要

add

 

list

 

5.208.1. add POST
リンクのコピー

Expand
表5.640 パラメーターの概要
Nameタイプ方向概要

watchdog

Watchdog

In/Out

 

5.208.2. list GET
リンクのコピー

Expand
表5.641 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すウォッチドッグの最大数を設定します。

watchdogs

Watchdog[]

Out

 
5.208.2.1. max
リンクのコピー

返すウォッチドッグの最大数を設定します。指定しない場合、すべてのウォッチドッグが返されます。

5.209. テンプレート
リンクのコピー

このサービスは、システムで使用可能な仮想マシンテンプレートを管理します。

Expand
表5.642 メソッドの概要
Name概要

add

新しいテンプレートを作成します。

list

仮想マシンテンプレートの一覧を返します。

5.209.1. add POST
リンクのコピー

新しいテンプレートを作成します。

これには、name 要素と vm 要素が必要です。id name 属性で仮想マシンを特定します。 

POST /ovirt-engine/api/templates
Copy to Clipboard Toggle word wrap

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

<template>
  <name>mytemplate</name>
  <vm id="123"/>
</template>
Copy to Clipboard Toggle word wrap

テンプレートは、既存のテンプレートのサブバージョンとして作成できます。これには、新しいテンプレートに name および vm 属性と、新しいテンプレートバージョンの base_template および version_name 属性が必要です。base_template および version_name 属性は、template セクションにある version セクション内で指定する必要があります。id または name 属性で仮想マシンを識別します。 

<template>
  <name>mytemplate</name>
  <vm id="123"/>
  <version>
    <base_template id="456"/>
    <version_name>mytemplate_001</version_name>
  </version>
</template>
Copy to Clipboard Toggle word wrap
Expand
表5.643 パラメーターの概要
Nameタイプ方向概要

clone_permissions

ブール値

In

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

template

Template

In/Out

テンプレートまたはテンプレートバージョンに関する情報。

5.209.1.1. clone_permissions
リンクのコピー

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

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

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

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

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

5.209.2. list GET
リンクのコピー

仮想マシンテンプレートの一覧を返します。

以下に例を示します。 

GET /ovirt-engine/api/templates
Copy to Clipboard Toggle word wrap

仮想マシンと仮想マシンテンプレートの一覧を返します。

Expand
表5.644 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

filter

ブール値

In

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

max

Integer

In

返すテンプレートの最大数を設定します。

search

String

In

返されたボリュームを制限するために使用されるクエリー文字列です。

templates

Template[]

Out

仮想マシンテンプレートのリスト。

5.209.2.1. case_sensitive
リンクのコピー

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

5.209.2.2. max
リンクのコピー

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

5.210. UnmanagedNetwork
リンクのコピー

Expand
表5.645 メソッドの概要
Name概要

get

 

remove

 

5.210.1. get GET
リンクのコピー

Expand
表5.646 パラメーターの概要
Nameタイプ方向概要

network

UnmanagedNetwork

Out

 

5.210.2. remove DELETE
リンクのコピー

Expand
表5.647 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.211. UnmanagedNetworks
リンクのコピー

Expand
表5.648 メソッドの概要
Name概要

list

 

5.211.1. list GET
リンクのコピー

Expand
表5.649 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すネットワークの最大数を設定します。

networks

UnmanagedNetwork[]

Out

 
5.211.1.1. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

5.212. User
リンクのコピー

システム内のユーザーを管理するサービス。このサービスを使用して、ユーザーの詳細を取得するか、ユーザーを削除します。新しいユーザーを追加するには、「Users」 を使用します。

Expand
表5.650 メソッドの概要
Name概要

get

システムユーザー情報を取得します。

remove

システムユーザーを削除します。

5.212.1. get GET
リンクのコピー

システムユーザー情報を取得します。

使用方法 

GET /ovirt-engine/api/users/1234
Copy to Clipboard Toggle word wrap

ユーザー情報を返します。 

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
  <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
  <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
  <department></department>
  <domain_entry_id>23456</domain_entry_id>
  <email>user1@domain.com</email>
  <last_name>Lastname</last_name>
  <namespace>*</namespace>
  <principal>user1</principal>
  <user_name>user1@domain-authz</user_name>
  <domain href="/ovirt-engine/api/domains/45678" id="45678">
    <name>domain-authz</name>
  </domain>
</user>
Copy to Clipboard Toggle word wrap
Expand
表5.651 パラメーターの概要
Nameタイプ方向概要

user

User

Out

システムユーザー。

5.212.2. remove DELETE
リンクのコピー

システムユーザーを削除します。

使用方法 

DELETE /ovirt-engine/api/users/1234
Copy to Clipboard Toggle word wrap
Expand
表5.652 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.213. Users
リンクのコピー

システム内のユーザーを管理するサービス。

Expand
表5.653 メソッドの概要
Name概要

add

ディレクトリーサービスからユーザーを追加します。

list

システム内のすべてのユーザーを一覧表示します。

5.213.1. add POST
リンクのコピー

ディレクトリーサービスからユーザーを追加します。

たとえば、myextension-authz 承認プロバイダーから myuser ユーザーを追加するには、次のようなリクエストを送信します。 

POST /ovirt-engine/api/users
Copy to Clipboard Toggle word wrap

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

<user>
  <user_name>myuser@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>
Copy to Clipboard Toggle word wrap

Active Directory を使用している場合は、ユーザープリンシパル名 (UPN) を username として渡し、その後に承認プロバイダー名を渡す必要があります。バグ 1147900 のため、ユーザーの UPN に設定された principal パラメーターも提供する必要があります。

たとえば、UPN myuser@mysubdomain.mydomain.com を持つユーザーを myextension-authz 承認プロバイダーから追加するには、以下のようなリクエスト本文を送信します。 

<user>
  <principal>myuser@mysubdomain.mydomain.com</principal>
  <user_name>myuser@mysubdomain.mydomain.com@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>
Copy to Clipboard Toggle word wrap
Expand
表5.654 パラメーターの概要
Nameタイプ方向概要

user

User

In/Out

 

5.213.2. list GET
リンクのコピー

システム内のすべてのユーザーを一覧表示します。

使用方法 

GET /ovirt-engine/api/users
Copy to Clipboard Toggle word wrap

ユーザーの一覧を返します。 

<users>
  <user href="/ovirt-engine/api/users/1234" id="1234">
    <name>admin</name>
    <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
    <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
    <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
    <domain_entry_id>23456</domain_entry_id>
    <namespace>*</namespace>
    <principal>user1</principal>
    <user_name>user1@domain-authz</user_name>
    <domain href="/ovirt-engine/api/domains/45678" id="45678">
      <name>domain-authz</name>
    </domain>
  </user>
</users>
Copy to Clipboard Toggle word wrap
Expand
表5.655 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

max

Integer

In

返すユーザーの最大数を設定します。

search

String

In

返されるユーザーを制限するために使用されるクエリー文字列。

users

User[]

Out

ユーザーのリスト。

5.213.2.1. case_sensitive
リンクのコピー

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

5.213.2.2. max
リンクのコピー

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

5.214. VirtualFunctionAllowedNetwork
リンクのコピー

Expand
表5.656 メソッドの概要
Name概要

get

 

remove

 

5.214.1. get GET
リンクのコピー

Expand
表5.657 パラメーターの概要
Nameタイプ方向概要

network

Network

Out

 

5.214.2. remove DELETE
リンクのコピー

Expand
表5.658 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.215. VirtualFunctionAllowedNetworks
リンクのコピー

Expand
表5.659 メソッドの概要
Name概要

add

 

list

 

5.215.1. add POST
リンクのコピー

Expand
表5.660 パラメーターの概要
Nameタイプ方向概要

network

Network

In/Out

 

5.215.2. list GET
リンクのコピー

Expand
表5.661 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すネットワークの最大数を設定します。

networks

Network[]

Out

 
5.215.2.1. max
リンクのコピー

返すネットワークの最大数を設定します。指定されていない場合には、すべてのネットワークが返されます。

5.216. Vm
リンクのコピー

Expand
表5.662 メソッドの概要
Name概要

cancelmigration

この操作は、別の物理ホストへの仮想マシンの移行を停止します。

clone

 

commitsnapshot

 

detach

プールから仮想マシンをデタッチします。

export

仮想マシンをエクスポートドメインにエクスポートします。

freezefilesystems

仮想マシンのファイルシステムをフリーズします。

get

仮想マシンの説明を取得します。

logon

外部コンソールから仮想マシンにアクセスするための自動ユーザーログオンを開始します。

maintenance

 

migrate

この操作により、仮想マシンを別の物理ホストに移行します。

previewsnapshot

 

reboot

この操作は、再起動要求を仮想マシンに送信します。

remove

アタッチされている仮想ディスクを含む仮想マシンを削除します。

reordermacaddresses

 

shutdown

この操作は、シャットダウンリクエストを仮想マシンに送信します。

start

仮想マシンを起動します。

stop

この操作により、仮想マシンの電源が強制的にオフになります。

suspend

この操作により、仮想マシンの状態がディスクに保存され、停止されます。

thawfilesystems

仮想マシンのファイルシステムをフリーズします。

ticket

仮想マシンのディスプレイにアクセスするための時間制約のある認証トークンを生成します。

undosnapshot

 

update

 

5.216.1. cancelmigration POST
リンクのコピー

この操作は、別の物理ホストへの仮想マシンの移行を停止します。 

POST /ovirt-engine/api/vms/123/cancelmigration
Copy to Clipboard Toggle word wrap

cancel migration アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.663 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

移行を非同期的にキャンセルする必要があるかどうかを示します。

5.216.2. clone POST
リンクのコピー

Expand
表5.664 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

クローンを非同期で実行するかどうかを示します。

vm

Vm

In

 

5.216.3. commitsnapshot POST
リンクのコピー

Expand
表5.665 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

スナップショットを非同期でコミットする必要があるかどうかを示します。

5.216.4. detach POST
リンクのコピー

プールから仮想マシンをデタッチします。 

POST /ovirt-engine/api/vms/123/detach
Copy to Clipboard Toggle word wrap

detach アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.666 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

デタッチを非同期で実行する必要があるかどうかを示します。

5.216.5. export POST
リンクのコピー

仮想マシンをエクスポートドメインにエクスポートします。

たとえば、仮想マシン 123 をエクスポートドメイン myexport にエクスポートするには、次のようなリクエストを送信します。 

POST /ovirt-engine/api/vms/123/export
Copy to Clipboard Toggle word wrap

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

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <exclusive>true</exclusive>
  <discard_snapshots>true</discard_snapshots>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.667 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

エクスポートを非同期で実行する必要があるかどうかを示します。

discard_snapshots

ブール値

In

discard_snapshots パラメーターは、仮想マシンが折りたたまれた状態でエクスポートされる必要がある場合に使用されます。

exclusive

ブール値

In

exclusive パラメーターは、仮想マシンの別のコピーがエクスポートドメインにすでに存在する場合でも、その仮想マシンをエクスポートする必要がある場合に使用されます（上書き）。

storage_domain

StorageDomain

In

 

5.216.6. freezefilesystems POST
リンクのコピー

仮想マシンのファイルシステムをフリーズします。

この操作は、実行中の仮想マシンのライブスナップショットを作成するときに、QEMU ゲストエージェントを使用して仮想マシンのファイルシステムをフリーズします。通常、これはマネージャーによって自動的に行われますが、OpenStack Volume (Cinder) ディスクを使用する仮想マシンでは API を使用して手動で実行する必要があります。

以下に例を示します。 

POST /ovirt-engine/api/vms/123/freezefilesystems
Copy to Clipboard Toggle word wrap 
<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.668 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

フリーズを非同期で実行する必要があるかどうかを示します。

5.216.7. get GET
リンクのコピー

仮想マシンの説明を取得します。

Expand
表5.669 パラメーターの概要
Nameタイプ方向概要

all_content

ブール値

In

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

filter

ブール値

In

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

next_run

ブール値

In

返された結果が現在実行中の仮想マシンを記述しているか、またはすでに実行されたが再起動時にのみ有効です。

vm

Vm

Out

仮想マシンの説明。

5.216.7.1. all_content
リンクのコピー

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

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

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

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

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

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

5.216.7.2. next_run
リンクのコピー

返された結果が現在実行中の仮想マシンを記述しているか、またはすでに実行されたが再起動時にのみ有効です。デフォルトでは、値は false です。

パラメーターがリクエストに含まれているが値がない場合、値は true であると仮定されるため、以下の要求になります。 

GET /vms/{vm:id};next_run
Copy to Clipboard Toggle word wrap

値 true を使用することと同等です。 

GET /vms/{vm:id};next_run=true
Copy to Clipboard Toggle word wrap

5.216.8. logon POST
リンクのコピー

外部コンソールから仮想マシンにアクセスするための自動ユーザーログオンを開始します。

このアクションには、ovirt-guest-agent-gdm-plugin および ovirt-guest-agent-pam-module パッケージがインストールされ、ovirt-guest-agent サービスが仮想マシンで実行されている必要があります。

ユーザーが外部コンソールから仮想マシンにアクセスするには、仮想マシンに対する適切なユーザー権限が必要です。

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

POST /ovirt-engine/api/vms/123/logon
Copy to Clipboard Toggle word wrap

リクエスト本文: 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.670 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

ログオンを非同期で実行する必要があるかどうかを示します。

5.216.9. maintenance POST
リンクのコピー

Expand
表5.671 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

maintenance_enabled

ブール値

In

 

5.216.10. migrate POST
リンクのコピー

この操作により、仮想マシンを別の物理ホストに移行します。 

POST /ovirt-engine/api/vms/123/migrate
Copy to Clipboard Toggle word wrap

仮想マシンの移行先の特定のホストを指定できます。 

<action>
  <host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.672 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

移行を非同期的に実行するかどうかを指定します。

cluster

Cluster

In

仮想マシンの移行先のクラスターを指定します。

force

ブール値

In

移行不可として定義されている可能性がありますが、仮想マシンを移行する必要があるを指定します。

host

ホスト

In

仮想マシンの移行先となる特定のホストを指定します。

5.216.10.1. cluster
リンクのコピー

仮想マシンの移行先のクラスターを指定します。これはオプションのパラメーターです。デフォルトでは、仮想マシンは同じクラスター内の別のホストに移行されます。

5.216.10.2. force
リンクのコピー

移行不可として定義されている可能性がありますが、仮想マシンを移行する必要があるを指定します。これはオプションのパラメーターです。デフォルトでは false に設定されます。

5.216.10.3. host
リンクのコピー

仮想マシンの移行先となる特定のホストを指定します。これはオプションのパラメーターです。デフォルトでは、oVirt Engine は、同じクラスター内で移行用のデフォルトホストを自動的に選択します。API ユーザーが特定のホストを必要とする場合、ユーザーは id または name パラメーターを使用してホストを指定できます。

5.216.11. previewsnapshot POST
リンクのコピー

Expand
表5.673 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

プレビューを非同期で実行する必要があるかどうかを示します。

disks

Disk[]

In

 

restore_memory

ブール値

In

 

snapshot

スナップショット

In

 

vm

Vm

In

 

5.216.12. reboot POST
リンクのコピー

この操作は、再起動要求を仮想マシンに送信します。 

POST /ovirt-engine/api/vms/123/reboot
Copy to Clipboard Toggle word wrap

再起動アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.674 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

再起動を非同期で実行する必要があるかどうかを示します。

5.216.13. remove DELETE
リンクのコピー

アタッチされている仮想ディスクを含む仮想マシンを削除します。

たとえば、識別子が 123 の仮想マシンを削除するには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap
Expand
表5.675 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

detach_only

ブール値

In

アタッチされた仮想ディスクを削除する代わりに、最初にデタッチして保持する必要があるかどうかを示しています。

force

ブール値

In

仮想マシンを強制的に削除する必要があるかどうかを示します。

5.216.13.1. force
リンクのコピー

仮想マシンを強制的に削除する必要があるかどうかを示します。

ロックされた仮想マシンおよびロックされたディスクイメージを持つ仮想マシンは、このフラグを true に設定しないと削除できません。

5.216.14. reordermacaddresses POST
リンクのコピー

Expand
表5.676 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.216.15. shutdown POST
リンクのコピー

この操作は、シャットダウンリクエストを仮想マシンに送信します。 

POST /ovirt-engine/api/vms/123/shutdown
Copy to Clipboard Toggle word wrap

shutdown アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.677 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

シャットダウンを非同期で実行する必要があるかどうかを示します。

5.216.16. start POST
リンクのコピー

仮想マシンを起動します。

仮想環境が完成し、機能するために必要なすべてのコンポーネントが仮想マシンに含まれている場合は、仮想マシンを起動できます。

この例では、仮想マシンを起動します。 

POST /ovirt-engine/api/vms/123/start
Copy to Clipboard Toggle word wrap

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

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.678 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

filter

ブール値

In

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

pause

ブール値

In

true に設定されている場合、仮想マシンを一時停止モードで起動します。

use_cloud_init

ブール値

In

true に設定すると、初期化タイプは cloud-init に設定されます。

use_sysprep

ブール値

In

true に設定すると、初期化タイプは Sysprep に設定されます。

vm

Vm

In

この特定の実行のための仮想マシンの定義。

5.216.16.1. pause
リンクのコピー

true に設定されている場合、仮想マシンを一時停止モードで起動します。デフォルトは false です。

5.216.16.2. use_cloud_init
リンクのコピー

true に設定すると、初期化タイプは cloud-init に設定されます。デフォルト値は false です。詳細は、こちら を参照してください。

5.216.16.3. use_sysprep
リンクのコピー

true に設定すると、初期化タイプは Sysprep に設定されます。デフォルト値は false です。詳細は、こちら を参照してください。

5.216.16.4. vm
リンクのコピー

この特定の実行のための仮想マシンの定義。

以下に例を示します。 

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

これにより、この特定の起動に対してのみブートデバイスが CDROM に設定されます。仮想マシンの電源がオフになると、この定義は元に戻されます。

5.216.17. stop POST
リンクのコピー

この操作により、仮想マシンの電源が強制的にオフになります。 

POST /ovirt-engine/api/vms/123/stop
Copy to Clipboard Toggle word wrap

stop アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.679 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.216.18. suspend POST
リンクのコピー

この操作により、仮想マシンの状態がディスクに保存され、停止されます。停止された仮想マシンを起動し、起動アクションで仮想マシンの状態を復元します。 

POST /ovirt-engine/api/vms/123/suspend
Copy to Clipboard Toggle word wrap

suspend アクションはアクション固有のパラメーターを取りません。したがって、リクエスト本文には空の action が含まれている必要があります。 

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.680 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.216.19. thawfilesystems POST
リンクのコピー

仮想マシンのファイルシステムをフリーズします。

この操作は、実行中の仮想マシンのライブスナップショットを作成するときに、QEMU ゲストエージェントを使用して仮想マシンのファイルシステムを解凍します。通常、これはマネージャーによって自動的に行われますが、OpenStack Volume (Cinder) ディスクを使用する仮想マシンでは API を使用して手動で実行する必要があります。

以下に例を示します。 

POST /api/vms/123/thawfilesystems
Copy to Clipboard Toggle word wrap 
<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.681 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.216.20. ticket POST
リンクのコピー

仮想マシンのディスプレイにアクセスするための時間制約のある認証トークンを生成します。 

POST /ovirt-engine/api/vms/123/ticket
Copy to Clipboard Toggle word wrap

クライアント指定のアクションには、必要に応じて、必要なチケット値および/または有効期限 (秒単位) が含まれます。

いずれの場合も、応答は実際に使用されたチケットの値と有効期限を指定します。 

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>
Copy to Clipboard Toggle word wrap
Expand
表5.682 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

チケットの生成を非同期で実行する必要があるかどうかを示します。

ticket

Ticket

In/Out

 

5.216.21. undosnapshot POST
リンクのコピー

Expand
表5.683 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクションを非同期で実行する必要があるかどうかを示します。

5.216.22. update PUT
リンクのコピー

Expand
表5.684 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

next_run

ブール値

In

更新を仮想マシンに適用するか、仮想マシンの再起動時にのみ適用するかを示します。

vm

Vm

In/Out

 
5.216.22.1. next_run
リンクのコピー

更新を仮想マシンに適用するか、仮想マシンの再起動時にのみ適用するかを示します。デフォルト値は false で、デフォルトでは変更が即座に適用されます。

5.217. VmApplication
リンクのコピー

仮想マシンにインストールされたアプリケーションに関する情報を提供するサービス。

Expand
表5.685 メソッドの概要
Name概要

get

アプリケーションに関する情報を返します。

5.217.1. get GET
リンクのコピー

アプリケーションに関する情報を返します。

Expand
表5.686 パラメーターの概要
Nameタイプ方向概要

application

アプリケーション

Out

アプリケーションに関する情報。

filter

ブール値

In

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

5.217.1.1. application
リンクのコピー

アプリケーションに関する情報。

この情報には、アプリケーションの名前を含む name 属性 (バージョンなどの追加情報を含む場合がある任意の文字列) と、仮想マシンを識別する vm 属性でが含まれます。

たとえば、以下のようなリクエストです。 

GET /ovirt-engine/api/vms/123/applications/789
Copy to Clipboard Toggle word wrap

次のような情報が返される場合があります。 

<application href="/ovirt-engine/api/vms/123/applications/789" id="789">
  <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>
Copy to Clipboard Toggle word wrap

5.218. VmApplications
リンクのコピー

仮想マシンにインストールされているアプリケーションに関する情報を提供するサービス。

Expand
表5.687 メソッドの概要
Name概要

list

仮想マシンにインストールされているアプリケーションの一覧を返します。

5.218.1. list GET
リンクのコピー

仮想マシンにインストールされているアプリケーションの一覧を返します。

Expand
表5.688 パラメーターの概要
Nameタイプ方向概要

applications

Application[]

Out

仮想マシンにインストールされているアプリケーションのリスト。

filter

ブール値

In

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

max

Integer

In

返すアプリケーションの最大数を設定します。

5.218.1.1. applications
リンクのコピー

仮想マシンにインストールされているアプリケーションのリスト。

たとえば、以下のようなリクエストです。 

GET /ovirt-engine/api/vms/123/applications/
Copy to Clipboard Toggle word wrap

次のようなリストが返される場合があります。 

<applications>
  <application href="/ovirt-engine/api/vms/123/applications/456" id="456">
    <name>kernel-3.10.0-327.36.1.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
  <application href="/ovirt-engine/api/vms/123/applications/789" id="789">
    <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
</applications>
Copy to Clipboard Toggle word wrap
5.218.1.2. max
リンクのコピー

返すアプリケーションの最大数を設定します。指定されていない場合は、すべてのアプリケーションが返されます。

5.219. VmCdrom
リンクのコピー

仮想マシンの CDROM デバイスを管理します。

ディスクの変更と取り出しは、file 属性の値を変更するために、常に update メソッドを使用して行われます。

Expand
表5.689 メソッドの概要
Name概要

get

この CDROM デバイスに関する情報を返します。

update

この CDROM デバイスに関する情報を更新します。

5.219.1. get GET
リンクのコピー

この CDROM デバイスに関する情報を返します。

この情報は、CDROM デバイス、仮想マシン、およびオプションで挿入されたディスクへの参照を含む cdrom 属性で設定されます。

ディスクが挿入されている場合は、file 属性には ISO イメージへの参照が含まれます。 

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <file id="mycd.iso"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>
Copy to Clipboard Toggle word wrap

ディスクが挿入されていない場合は、file 属性は報告されません。 

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>
Copy to Clipboard Toggle word wrap
Expand
表5.690 パラメーターの概要
Nameタイプ方向概要

cdrom

Cdrom

Out

CDROM デバイスに関する情報。

current

ブール値

In

操作が現在実行中の仮想マシンの情報を返す必要があるかどうかを示します。

5.219.1.1. current
リンクのコピー

操作が現在実行中の仮想マシンの情報を返す必要があるかどうかを示します。このパラメーターはオプションであり、デフォルト値は false です。

5.219.2. update PUT
リンクのコピー

この CDROM デバイスに関する情報を更新します。

file 属性の値を変更することにより、ディスクを変更またはイジェクトすることができます。たとえば、ディスクを挿入または変更するには、次のようなリクエストを送信します。 

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000
Copy to Clipboard Toggle word wrap

本文には、file 属性の新しい値が含まれている必要があります。 

<cdrom>
  <file id="mycd.iso"/>
</cdrom>
Copy to Clipboard Toggle word wrap

id 属性の値 (この例では mycd.iso) は、アタッチされた ISO ストレージドメインで使用可能なファイルに対応している必要があります。

ディスクのイジェクトには、空の id を持つ file を使用します。 

<cdrom>
  <file id=""/>
</cdrom>
Copy to Clipboard Toggle word wrap

デフォルトでは、上記の操作は次回の起動後に仮想マシンに表示されるディスクを永続的に変更しますが、現在実行中の仮想マシンには影響しません。現在実行中の仮想マシンに表示されるディスクを変更する場合は、current=true パラメーターを追加します。たとえば、現在のディスクを取り出すには、次のようなリクエストを送信します。 

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true
Copy to Clipboard Toggle word wrap

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

<cdrom>
  <file id=""/>
</cdrom>
Copy to Clipboard Toggle word wrap
重要

current=true パラメーターで行われた変更は永続化されないため、仮想マシンの再起動後は効果がありません。

Expand
表5.691 パラメーターの概要
Nameタイプ方向概要

cdrom

Cdrom

In/Out

CDROM デバイスに関する情報。

current

ブール値

In

現在実行中の仮想マシンに更新を適用するか、次回の起動後の仮想マシンに適用するかを指定します。

5.219.2.1. current
リンクのコピー

現在実行中の仮想マシンに更新を適用するか、次回の起動後の仮想マシンに適用するかを指定します。このパラメーターはオプションであり、デフォルト値は false です。これは、デフォルトでは次回の起動後にのみ更新が有効になることを意味します。

5.220. VmCdroms
リンクのコピー

仮想マシンの CDROM デバイスを管理します。

現在、仮想マシンには CDROM デバイスが 1 つだけあります。新しいデバイスを追加することはできず、既存のデバイスを削除することもできないため、add または remove のメソッドはありません。CDROM ディスクの変更と取り出しは、CDROM デバイスを管理する service の update メソッドで行います。

Expand
表5.692 メソッドの概要
Name概要

list

仮想マシンの CDROM デバイスの一覧を返します。

5.220.1. list GET
リンクのコピー

仮想マシンの CDROM デバイスの一覧を返します。

Expand
表5.693 パラメーターの概要
Nameタイプ方向概要

cdroms

Cdrom[]

Out

仮想マシンの CDROM デバイスのリスト。

max

Integer

In

返す CDROM の最大数を設定します。

5.220.1.1. max
リンクのコピー

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

5.221. VmDisk
リンクのコピー

Expand
表5.694 メソッドの概要
Name概要

activate

 

deactivate

 

export

 

get

 

move

 

remove

仮想マシンからディスクを切り離します。

update

 

5.221.1. activate POST
リンクのコピー

Expand
表5.695 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクティベーションを非同期で実行する必要があるかどうかを示します。

5.221.2. deactivate POST
リンクのコピー

Expand
表5.696 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

非アクティブ化を非同期で実行する必要があるかどうかを示します。

5.221.3. export POST
リンクのコピー

Expand
表5.697 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

エクスポートを非同期で実行する必要があるかどうかを示します。

filter

ブール値

In

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

5.221.4. get GET
リンクのコピー

Expand
表5.698 パラメーターの概要
Nameタイプ方向概要

disk

ディスク

Out

 

5.221.5. move POST
リンクのコピー

Expand
表5.699 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

移動を非同期で実行する必要があるかどうかを示します。

filter

ブール値

In

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

5.221.6. remove DELETE
リンクのコピー

仮想マシンからディスクを切り離します。

注記

API のバージョン 3 では、これによりディスクがシステムから完全に削除されていましたが、バージョン 4 以降では削除されません。完全に削除する必要がある場合は、最上位のディスクサービスの remove メソッド を使用します。

Expand
表5.700 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.221.7. update PUT
リンクのコピー

Expand
表5.701 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

disk

ディスク

In/Out

 

5.222. VmDisks
リンクのコピー

Expand
表5.702 メソッドの概要
Name概要

add

 

list

 

5.222.1. add POST
リンクのコピー

Expand
表5.703 パラメーターの概要
Nameタイプ方向概要

disk

ディスク

In/Out

 

5.222.2. list GET
リンクのコピー

Expand
表5.704 パラメーターの概要
Nameタイプ方向概要

disks

Disk[]

Out

 

max

Integer

In

返すディスクの最大数を設定します。

5.222.2.1. max
リンクのコピー

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

5.223. VmGraphicsConsole
リンクのコピー

Expand
表5.705 メソッドの概要
Name概要

get

グラフィックコンソールの設定を取得します。

proxyticket

 

remove

 

5.223.1. get GET
リンクのコピー

グラフィックコンソールの設定を取得します。

Expand
表5.706 パラメーターの概要
Nameタイプ方向概要

console

GraphicsConsole

Out

 

current

ブール値

In

以下のクエリーを使用して、グラフィックコンソールの現在のランタイム設定を取得します。

5.223.1.1. current
リンクのコピー

以下のクエリーを使用して、グラフィックコンソールの現在のランタイム設定を取得します。 

GET /ovit-engine/api/vms/{vm:id}/graphicsconsoles/{console:id}?current=true
Copy to Clipboard Toggle word wrap

デフォルト値は false です。

5.223.2. proxyticket POST
リンクのコピー

Expand
表5.707 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

チケットの生成を非同期で実行する必要があるかどうかを示します。

proxy_ticket

ProxyTicket

Out

 

5.223.3. remove DELETE
リンクのコピー

Expand
表5.708 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.224. VmHostDevice
リンクのコピー

仮想マシンにアタッチされた個々のホストデバイスを管理するサービス。

Expand
表5.709 メソッドの概要
Name概要

get

特定の仮想マシンにアタッチされた特定のホストデバイスに関する情報を取得します。

remove

このホストデバイスの接続を特定の仮想マシンから削除します。

5.224.1. get GET
リンクのコピー

特定の仮想マシンにアタッチされた特定のホストデバイスに関する情報を取得します。

以下に例を示します。 

GET /ovirt-engine/api/vms/123/hostdevices/456
Copy to Clipboard Toggle word wrap 
<host_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
  <name>pci_0000_04_00_0</name>
  <capability>pci</capability>
  <iommu_group>30</iommu_group>
  <placeholder>true</placeholder>
  <product id="0x13ba">
    <name>GM107GL [Quadro K2200]</name>
  </product>
  <vendor id="0x10de">
    <name>NVIDIA Corporation</name>
  </vendor>
  <host href="/ovirt-engine/api/hosts/543" id="543"/>
  <parent_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
    <name>pci_0000_00_03_0</name>
  </parent_device>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</host_device>
Copy to Clipboard Toggle word wrap
Expand
表5.710 パラメーターの概要
Nameタイプ方向概要

device

HostDevice

Out

特定の仮想マシンにアタッチされたホストデバイスに関する情報を取得しました。

5.224.2. remove DELETE
リンクのコピー

このホストデバイスの接続を特定の仮想マシンから削除します。

注記

このデバイスが IOMMU プレースホルダーとして機能する場合、削除することはできません (削除すると、placeholder フラグが true に設定されます)。すべての IOMMU プレースホルダーデバイスは、非プレースホルダーデバイスがなくなると同時に自動的に削除されることに注意してください (指定された IOMMU グループのすべてのデバイスが切り離されます)。 

DELETE /ovirt-engine/api/vms/123/hostdevices/456
Copy to Clipboard Toggle word wrap
Expand
表5.711 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.225. VmHostDevices
リンクのコピー

仮想マシンにアタッチされたホストデバイスを管理するサービス。

Expand
表5.712 メソッドの概要
Name概要

add

ターゲットデバイスを指定された仮想マシンにアタッチします。

list

指定された仮想マシンに割り当てられているホストデバイスを一覧表示します。

5.225.1. add POST
リンクのコピー

ターゲットデバイスを指定された仮想マシンにアタッチします。

以下に例を示します。 

POST /ovirt-engine/api/vms/123/hostdevices
Copy to Clipboard Toggle word wrap

HostDevice タイプのリクエスト本文の例 

<host_device id="123" />
Copy to Clipboard Toggle word wrap
注記

ホストデバイスを正常にアタッチするために必要な前提条件は、仮想マシンが 必ず 1 つのホストにピニングされていることです。その場合、このホストに関連してデバイス ID が取得されます。

注記

より大きな IOMMU グループの一部である PCI デバイスをアタッチすると、その IOMMU グループの残りのデバイスがプレースホルダーとしてアタッチされます。その後、これらのデバイスは、true に設定された HostDevice タイプの placeholder 属性を使用して識別されます。

すでに IOMMU プレースホルダーとして機能しているデバイスをアタッチする場合は、そのデバイスに対して明示的な Add 操作を発行するだけで、その placeholder フラグがクリアされ、デバイスが仮想マシンにアクセスできるようになります。

Expand
表5.713 パラメーターの概要
Nameタイプ方向概要

device

HostDevice

In/Out

指定された仮想マシンにアタッチするホストデバイス。

5.225.2. list GET
リンクのコピー

指定された仮想マシンに割り当てられているホストデバイスを一覧表示します。

Expand
表5.714 パラメーターの概要
Nameタイプ方向概要

device

HostDevice[]

Out

取得した、指定された仮想マシンにアタッチされているホストデバイスのリスト。

max

Integer

In

返すデバイスの最大数を設定します。

5.225.2.1. max
リンクのコピー

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

5.226. VmNic
リンクのコピー

Expand
表5.715 メソッドの概要
Name概要

activate

 

deactivate

 

get

 

remove

NIC を削除します。

update

NIC を更新します。

5.226.1. activate POST
リンクのコピー

Expand
表5.716 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

アクティベーションを非同期で実行する必要があるかどうかを示します。

5.226.2. deactivate POST
リンクのコピー

Expand
表5.717 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

非アクティブ化を非同期で実行する必要があるかどうかを示します。

5.226.3. get GET
リンクのコピー

Expand
表5.718 パラメーターの概要
Nameタイプ方向概要

nic

Nic

Out

 

5.226.4. remove DELETE
リンクのコピー

NIC を削除します。

たとえば、ID 123 の仮想マシンから ID 456 の NIC を削除するには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/vms/123/nics/456
Copy to Clipboard Toggle word wrap
重要

ホットプラグ機能は、ホットプラグ操作を行う仮想マシンオペレーティングシステムのみをサポートします。オペレーティングシステムの例は次のとおりです。

  • Red Hat Enterprise Linux 6
  • Red Hat Enterprise Linux 5
  • Windows Server 2008 および
  • Windows Server 2003
Expand
表5.719 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.226.5. update PUT
リンクのコピー

NIC を更新します。

たとえば、ID 123 の仮想マシンに属する 456 を持つ NIC を更新するには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/vms/123/nics/456
Copy to Clipboard Toggle word wrap

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

<nic>
  <name>mynic</name>
  <interface>e1000</interface>
</nic>
Copy to Clipboard Toggle word wrap
重要

ホットプラグ機能は、ホットプラグ操作を行う仮想マシンオペレーティングシステムのみをサポートします。オペレーティングシステムの例は次のとおりです。

  • Red Hat Enterprise Linux 6
  • Red Hat Enterprise Linux 5
  • Windows Server 2008 および
  • Windows Server 2003
Expand
表5.720 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

nic

Nic

In/Out

 

5.227. VmNics
リンクのコピー

Expand
表5.721 メソッドの概要
Name概要

add

仮想マシンに NIC を追加します。

list

 

5.227.1. add POST
リンクのコピー

仮想マシンに NIC を追加します。

以下の例では、virtio と ovirtmgmt ネットワークを使用して、mynic という名前のネットワークインターフェイスを仮想マシンに追加します。 

POST /ovirt-engine/api/vms/123/nics
Copy to Clipboard Toggle word wrap 
<nic>
  <interface>virtio</interface>
  <name>mynic</name>
  <network>
    <name>ovirtmgmt</name>
  </network>
</nic>
Copy to Clipboard Toggle word wrap

次の例では、そのリクエストを curl を使用して送信しています。 

curl \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--user "admin@internal:mypassword" \
--cacert /etc/pki/ovirt-engine/ca.pem \
--data '
<nic>
  <name>mynic</name>
  <network>
    <name>ovirtmgmt</name>
  </network>
</nic>
' \
https://myengine.example.com/ovirt-engine/api/vms/123/nics
Copy to Clipboard Toggle word wrap
重要

ホットプラグ機能は、ホットプラグ操作を行う仮想マシンオペレーティングシステムのみをサポートします。オペレーティングシステムの例は次のとおりです。

  • Red Hat Enterprise Linux 6
  • Red Hat Enterprise Linux 5
  • Windows Server 2008 および
  • Windows Server 2003
Expand
表5.722 パラメーターの概要
Nameタイプ方向概要

nic

Nic

In/Out

 

5.227.2. list GET
リンクのコピー

Expand
表5.723 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返す NIC の最大数を設定します。

nics

Nic[]

Out

 
5.227.2.1. max
リンクのコピー

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

5.228. VmNumaNode
リンクのコピー

Expand
表5.724 メソッドの概要
Name概要

get

 

remove

仮想 NUMA ノードを削除します。

update

仮想 NUMA ノードを更新します。

5.228.1. get GET
リンクのコピー

Expand
表5.725 パラメーターの概要
Nameタイプ方向概要

node

VirtualNumaNode

Out

 

5.228.2. remove DELETE
リンクのコピー

仮想 NUMA ノードを削除します。

仮想 NUMA ノードを削除する例: 

DELETE /ovirt-engine/api/vms/123/numanodes/456
Copy to Clipboard Toggle word wrap
Expand
表5.726 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.228.3. update PUT
リンクのコピー

仮想 NUMA ノードを更新します。

仮想 NUMA ノードをホスト上の物理 NUMA ノードにピニングする例: 

PUT /ovirt-engine/api/vms/123/numanodes/456
Copy to Clipboard Toggle word wrap

リクエスト本文には、以下がが含まれている必要があります。 

<vm_numa_node>
  <numa_node_pins>
    <numa_node_pin>
      <index>0</index>
    </numa_node_pin>
  </numa_node_pins>
</vm_numa_node>
Copy to Clipboard Toggle word wrap
Expand
表5.727 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

node

VirtualNumaNode

In/Out

 

5.229. VmNumaNodes
リンクのコピー

Expand
表5.728 メソッドの概要
Name概要

add

仮想マシンの新しい仮想 NUMA ノードを作成します。

list

仮想マシンの仮想 NUMA ノードを一覧表示します。

5.229.1. add POST
リンクのコピー

仮想マシンの新しい仮想 NUMA ノードを作成します。

NUMA ノードの作成例: 

POST /ovirt-engine/api/vms/c7ecd2dc/numanodes
Accept: application/xml
Content-type: application/xml
Copy to Clipboard Toggle word wrap

リクエスト本文には、以下を含めることができます。 

<vm_numa_node>
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>1024</memory>
</vm_numa_node>
Copy to Clipboard Toggle word wrap
Expand
表5.729 パラメーターの概要
Nameタイプ方向概要

node

VirtualNumaNode

In/Out

 

5.229.2. list GET
リンクのコピー

仮想マシンの仮想 NUMA ノードを一覧表示します。

Expand
表5.730 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すノードの最大数を設定します。

nodes

VirtualNumaNode[]

Out

 
5.229.2.1. max
リンクのコピー

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

5.230. VmPool
リンクのコピー

仮想マシンプールを管理するためのサービス。

Expand
表5.731 メソッドの概要
Name概要

allocatevm

この操作により、仮想マシンが仮想マシンプールに割り当てられます。

get

仮想マシンプールを取得します。

remove

仮想マシンプールを削除します。

update

仮想マシンプールを更新します。

5.230.1. allocatevm POST
リンクのコピー

この操作により、仮想マシンが仮想マシンプールに割り当てられます。 

POST /ovirt-engine/api/vmpools/123/allocatevm
Copy to Clipboard Toggle word wrap

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

<action/>
Copy to Clipboard Toggle word wrap
Expand
表5.732 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

割り当てを非同期で実行する必要があるかどうかを示します。

5.230.2. get GET
リンクのコピー

仮想マシンプールを取得します。 

GET /ovirt-engine/api/vmpools/123
Copy to Clipboard Toggle word wrap

次のような XML 応答が返されます。 

<vm_pool id="123">
  <actions>...</actions>
  <name>MyVmPool</name>
  <description>MyVmPool description</description>
  <link href="/ovirt-engine/api/vmpools/123/permissions" rel="permissions"/>
  <max_user_vms>1</max_user_vms>
  <prestarted_vms>0</prestarted_vms>
  <size>100</size>
  <stateful>false</stateful>
  <type>automatic</type>
  <use_latest_template_version>false</use_latest_template_version>
  <cluster id="123"/>
  <template id="123"/>
  <vm id="123">...</vm>
  ...
</vm_pool>
Copy to Clipboard Toggle word wrap
Expand
表5.733 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

pool

VmPool

Out

取得した仮想マシンプール。

5.230.3. remove DELETE
リンクのコピー

仮想マシンプールを削除します。 

DELETE /ovirt-engine/api/vmpools/123
Copy to Clipboard Toggle word wrap
Expand
表5.734 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.230.4. update PUT
リンクのコピー

仮想マシンプールを更新します。 

PUT /ovirt-engine/api/vmpools/123
Copy to Clipboard Toggle word wrap

name、description、size、prestarted_vms、および max_user_vms 属性は、仮想マシンプールの作成後に更新できます。 

<vmpool>
  <name>VM_Pool_B</name>
  <description>Virtual Machine Pool B</description>
  <size>3</size>
  <prestarted_vms>1</size>
  <max_user_vms>2</size>
</vmpool>
Copy to Clipboard Toggle word wrap
Expand
表5.735 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

pool

VmPool

In/Out

更新中の仮想マシンプール。

5.231. VmPools
リンクのコピー

仮想マシンプールへの読み取り/書き込みアクセスを提供します。

Expand
表5.736 メソッドの概要
Name概要

add

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

list

使用可能な仮想マシンプールのリストを取得します。

5.231.1. add POST
リンクのコピー

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

新しいプールには、name、cluster、template の属性が必要です。id または name のネストされた属性でクラスターとテンプレートを特定します。 

POST /ovirt-engine/api/vmpools
Copy to Clipboard Toggle word wrap

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

<vmpool>
  <name>mypool</name>
  <cluster id="123"/>
  <template id="456"/>
</vmpool>
Copy to Clipboard Toggle word wrap
Expand
表5.737 パラメーターの概要
Nameタイプ方向概要

pool

VmPool

In/Out

追加するプール。

5.231.2. list GET
リンクのコピー

使用可能な仮想マシンプールのリストを取得します。 

GET /ovirt-engine/api/vmpools
Copy to Clipboard Toggle word wrap

以下の応答が返されます。 

<vm_pools>
  <vm_pool id="123">
    ...
  </vm_pool>
  ...
</vm_pools>
Copy to Clipboard Toggle word wrap
Expand
表5.738 パラメーターの概要
Nameタイプ方向概要

case_sensitive

ブール値

In

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

filter

ブール値

In

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

max

Integer

In

返すプールの最大数を設定します。

pools

VmPool[]

Out

取得したプール。

search

String

In

返されたプールを制限するために使用されるクエリー文字列。

5.231.2.1. case_sensitive
リンクのコピー

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

5.231.2.2. max
リンクのコピー

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

5.232. VmReportedDevice
リンクのコピー

Expand
表5.739 メソッドの概要
Name概要

get

 

5.232.1. get GET
リンクのコピー

Expand
表5.740 パラメーターの概要
Nameタイプ方向概要

reported_device

ReportedDevice

Out

 

5.233. VmReportedDevices
リンクのコピー

Expand
表5.741 メソッドの概要
Name概要

list

 

5.233.1. list GET
リンクのコピー

Expand
表5.742 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すデバイスの最大数を設定します。

reported_device

ReportedDevice[]

Out

 
5.233.1.1. max
リンクのコピー

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

5.234. VmSession
リンクのコピー

Expand
表5.743 メソッドの概要
Name概要

get

 

5.234.1. get GET
リンクのコピー

Expand
表5.744 パラメーターの概要
Nameタイプ方向概要

session

Session

Out

 

5.235. VmSessions
リンクのコピー

仮想マシンのユーザーセッションに関する情報を提供します。

Expand
表5.745 メソッドの概要
Name概要

list

この仮想マシンのすべてのユーザーセッションを一覧表示します。

5.235.1. list GET
リンクのコピー

この仮想マシンのすべてのユーザーセッションを一覧表示します。

たとえば、仮想マシン 123 のセッション情報を取得するには、以下のようなリクエストを送信します。 

GET /ovirt-engine/api/vms/123/sessions
Copy to Clipboard Toggle word wrap

応答本文には、次のような内容が含まれます。 

<sessions>
  <session href="/ovirt-engine/api/vms/123/sessions/456" id="456">
    <console_user>true</console_user>
    <ip>
      <address>192.168.122.1</address>
    </ip>
    <user href="/ovirt-engine/api/users/789" id="789"/>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </session>
  ...
</sessions>
Copy to Clipboard Toggle word wrap
Expand
表5.746 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すセッションの最大数を設定します。

sessions

Session[]

Out

 
5.235.1.1. max
リンクのコピー

返すセッションの最大数を設定します。指定されていない場合は、すべてのセッションが返されます。

5.236. VmWatchdog
リンクのコピー

仮想マシンのウォッチドッグを管理するサービス。

Expand
表5.747 メソッドの概要
Name概要

get

ウォッチドッグに関する情報を返します。

remove

仮想マシンからウォッチドッグを削除します。

update

ウォッチドッグの情報を更新します。

5.236.1. get GET
リンクのコピー

ウォッチドッグに関する情報を返します。

Expand
表5.748 パラメーターの概要
Nameタイプ方向概要

watchdog

Watchdog

Out

ウォッチドッグに関する情報です。

5.236.1.1. watchdog
リンクのコピー

ウォッチドッグに関する情報です。

この情報は、model 要素、action 要素、および仮想マシンへの参照で設定されます。たとえば、以下のようになります。 

<watchdogs>
  <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
    <action>poweroff</action>
    <model>i6300esb</model>
  </watchdog>
</watchdogs>
Copy to Clipboard Toggle word wrap

5.236.2. remove DELETE
リンクのコピー

仮想マシンからウォッチドッグを削除します。

たとえば、仮想マシンからウォッチドッグを削除するには、次のようなリクエストを送信します。 

DELETE /ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000
Copy to Clipboard Toggle word wrap
Expand
表5.749 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.236.3. update PUT
リンクのコピー

ウォッチドッグの情報を更新します。

action 要素と model 要素を使用して情報を更新できます。

たとえば、ウォッチドッグを更新するには、次のようなリクエストを送信します。 

PUT /ovirt-engine/api/vms/123/watchdogs
<watchdog>
  <action>reset</action>
</watchdog>
Copy to Clipboard Toggle word wrap

応答本文を使用: 

<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <action>reset</action>
  <model>i6300esb</model>
</watchdog>
Copy to Clipboard Toggle word wrap
Expand
表5.750 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

watchdog

Watchdog

In/Out

ウォッチドッグに関する情報です。

5.236.3.1. watchdog
リンクのコピー

ウォッチドッグに関する情報です。

リクエストデータには、model と action の少なくともどちらかの要素が必要です。応答データには、更新されたウォッチドッグに関する完全な情報が含まれています。

5.237. VmWatchdogs
リンクのコピー

仮想マシンのウォッチドッグを一覧表示します。

Expand
表5.751 メソッドの概要
Name概要

add

仮想マシンに新しいウォッチドッグを追加します。

list

仮想マシンのウォッチドッグのリスト。

5.237.1. add POST
リンクのコピー

仮想マシンに新しいウォッチドッグを追加します。

たとえば、ウォッチドッグを仮想マシンに追加するには、次のようなリクエストを送信します。 

POST /ovirt-engine/api/vms/123/watchdogs
<watchdog>
  <action>poweroff</action>
  <model>i6300esb</model>
</watchdog>
Copy to Clipboard Toggle word wrap

応答本文を使用: 

<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <action>poweroff</action>
  <model>i6300esb</model>
</watchdog>
Copy to Clipboard Toggle word wrap
Expand
表5.752 パラメーターの概要
Nameタイプ方向概要

watchdog

Watchdog

In/Out

ウォッチドッグに関する情報です。

5.237.1.1. watchdog
リンクのコピー

ウォッチドッグに関する情報です。

リクエストデータには、model 要素 (i6300esb など) と action 要素 (none、reset、poweroff、dump、pause のいずれか) が含まれている必要があります。応答データには、追加されたウォッチドッグおよび仮想マシンへの参照が含まれます。

5.237.2. list GET
リンクのコピー

仮想マシンのウォッチドッグのリスト。

Expand
表5.753 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すウォッチドッグの最大数を設定します。

watchdogs

Watchdog[]

Out

ウォッチドッグに関する情報です。

5.237.2.1. max
リンクのコピー

返すウォッチドッグの最大数を設定します。指定しない場合、すべてのウォッチドッグが返されます。

5.237.2.2. watchdogs
リンクのコピー

ウォッチドッグに関する情報です。

この情報は、model 要素、action 要素、および仮想マシンへの参照で設定されます。たとえば、以下のようになります。 

<watchdogs>
  <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
    <action>poweroff</action>
    <model>i6300esb</model>
  </watchdog>
</watchdogs>
Copy to Clipboard Toggle word wrap

5.238. Vms
リンクのコピー

Expand
表5.754 メソッドの概要
Name概要

add

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

list

 

5.238.1. add POST
リンクのコピー

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Expand
表5.755 パラメーターの概要
Nameタイプ方向概要

clone

ブール値

In

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

clone_permissions

ブール値

In

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

vm

Vm

In/Out

 
5.238.1.1. clone
リンクのコピー

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

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

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

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

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

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

5.238.1.2. clone_permissions
リンクのコピー

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

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

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

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

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

5.238.2. list GET
リンクのコピー

Expand
表5.756 パラメーターの概要
Nameタイプ方向概要

all_content

ブール値

In

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

case_sensitive

ブール値

In

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

filter

ブール値

In

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

max

Integer

In

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

search

String

In

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

vms

Vm[]

Out

 
5.238.2.1. all_content
リンクのコピー

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

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

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

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

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

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

5.238.2.2. case_sensitive
リンクのコピー

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

5.239. VnicProfile
リンクのコピー

このサービスは、vNIC プロファイルを管理します。

Expand
表5.757 メソッドの概要
Name概要

get

vNIC プロファイルの詳細を取得します。

remove

vNIC プロファイルを削除します。

update

vNIC プロファイルの詳細を更新します。

5.239.1. get GET
リンクのコピー

vNIC プロファイルの詳細を取得します。

Expand
表5.758 パラメーターの概要
Nameタイプ方向概要

profile

VnicProfile

Out

 

5.239.2. remove DELETE
リンクのコピー

vNIC プロファイルを削除します。

Expand
表5.759 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.239.3. update PUT
リンクのコピー

vNIC プロファイルの詳細を更新します。

Expand
表5.760 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

更新を非同期的に実行するかどうかを指定します。

profile

VnicProfile

In/Out

更新中の vNIC プロファイル。

5.240. VnicProfiles
リンクのコピー

このサービスは、すべての vNIC プロファイルのコレクションを管理します。

Expand
表5.761 メソッドの概要
Name概要

add

vNIC プロファイルを追加します。

list

すべての vNIC プロファイルを一覧表示します。

5.240.1. add POST
リンクのコピー

vNIC プロファイルを追加します。

たとえば、vNIC プロファイル 123 をネットワーク 456 に追加するには、次の宛先にリクエストを送信します。 

POST /ovirt-engine/api/networks/456/vnicprofiles
Copy to Clipboard Toggle word wrap

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

<vnic_profile id="123">
  <name>new_vNIC_name</name>
  <pass_through>
    <mode>disabled</mode>
  </pass_through>
  <port_mirroring>false</port_mirroring>
</vnic_profile>
Copy to Clipboard Toggle word wrap

各 VNIC プロファイルにはデフォルトのネットワークフィルターがあることに注意してください。デフォルトのネットワークフィルターの計算方法は、NetworkFilters のドキュメントを参照してください。

新しい VNIC プロファイル作成の出力は、指定された body 引数によって異なります。ネットワークフィルターが指定されていない場合は、デフォルトのネットワークフィルターが設定されます。以下に例を示します。 

<vnic_profile href="/ovirt-engine/api/vnicprofiles/123" id="123">
  <name>new_vNIC_name</name>
  <link href="/ovirt-engine/api/vnicprofiles/123/permissions" rel="permissions"/>
  <pass_through>
    <mode>disabled</mode>
  </pass_through>
  <port_mirroring>false</port_mirroring>
  <network href="/ovirt-engine/api/networks/456" id="456"/>
  <network_filter href="/ovirt-engine/api/networkfilters/789" id="789"/>
</vnic_profile>
Copy to Clipboard Toggle word wrap

空のネットワークフィルターが指定された場合、VNIC プロファイルのデフォルトネットワークフィルターに関係なく、特定の VNIC プロファイルに対してネットワークフィルターは設定されません。以下に例を示します。 

<vnic_profile>
  <name>no_network_filter</name>
  <network_filter/>
</vnic_profile>
Copy to Clipboard Toggle word wrap

特定の有効なネットワークフィルター ID が指定された場合、VNIC プロファイルのデフォルトネットワークフィルターに関係なく、指定されたネットワークフィルターを使用して VNIC プロファイルが設定されます。以下に例を示します。 

<vnic_profile>
  <name>user_choice_network_filter</name>
  <network_filter id= "0000001b-001b-001b-001b-0000000001d5"/>
</vnic_profile>
Copy to Clipboard Toggle word wrap
Expand
表5.762 パラメーターの概要
Nameタイプ方向概要

profile

VnicProfile

In/Out

追加される vNIC プロファイル。

5.240.2. list GET
リンクのコピー

すべての vNIC プロファイルを一覧表示します。

Expand
表5.763 パラメーターの概要
Nameタイプ方向概要

max

Integer

In

返すプロファイルの最大数を設定します。

profiles

VnicProfile[]

Out

すべての vNIC プロファイルのリスト。

5.240.2.1. max
リンクのコピー

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

5.241. 重み
リンクのコピー

Expand
表5.764 メソッドの概要
Name概要

get

 

remove

 

5.241.1. get GET
リンクのコピー

Expand
表5.765 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

weight

重み

Out

 

5.241.2. remove DELETE
リンクのコピー

Expand
表5.766 パラメーターの概要
Nameタイプ方向概要

async

ブール値

In

削除を非同期的に実行するかどうかを指定します。

5.242. 重み
リンクのコピー

Expand
表5.767 メソッドの概要
Name概要

add

 

list

 

5.242.1. add POST
リンクのコピー

Expand
表5.768 パラメーターの概要
Nameタイプ方向概要

weight

重み

In/Out

 

5.242.2. list GET
リンクのコピー

Expand
表5.769 パラメーターの概要
Nameタイプ方向概要

filter

ブール値

In

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

max

Integer

In

返す重みの最大数を設定します。

weights

Weight[]

Out

 
5.242.2.1. max
リンクのコピー

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

第6章 タイプ
リンクのコピー

このセクションでは、API で使用できるすべてのデータ型を列挙します。

6.1. AccessProtocol enum
リンクのコピー

Expand
表6.1 値の概要
Name概要

cifs

 

gluster

 

nfs

 

6.2. Action 構造体
リンクのコピー

Expand
表6.2 属性の概要
Nameタイプ概要

async

ブール値

 

bricks

GlusterBrick[]

 

certificates

Certificate[]

 

check_connectivity

ブール値

 

clone

ブール値

 

cluster

Cluster

 

collapse_snapshots

ブール値

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

connectivity_timeout

Integer

 

data_center

DataCenter

 

deploy_hosted_engine

ブール値

 

description

String

プレーンテキストでの人間が判読できる説明。

details

GlusterVolumeProfileDetails

 

discard_snapshots

ブール値

 

disk

ディスク

 

disks

Disk[]

 

exclusive

ブール値

 

fault

異常

 

fence_type

String

 

filter

ブール値

 

fix_layout

ブール値

 

force

ブール値

 

grace_period

GracePeriod

 

host

ホスト

 

id

String

一意の ID

image

String

 

import_as_template

ブール値

 

is_attached

ブール値

 

iscsi

IscsiDetails

 

iscsi_targets

String[]

 

job

Job

 

logical_units

LogicalUnit[]

 

maintenance_enabled

ブール値

 

modified_bonds

HostNic[]

 

modified_labels

NetworkLabel[]

 

modified_network_attachments

NetworkAttachment[]

 

name

String

人間が判読できるプレーンテキストでの名前。

option

オプション

 

pause

ブール値

 

power_management

PowerManagement

 

proxy_ticket

ProxyTicket

 

reason

String

 

removed_bonds

HostNic[]

 

removed_labels

NetworkLabel[]

 

removed_network_attachments

NetworkAttachment[]

 

resolution_type

String

 

restore_memory

ブール値

 

root_password

String

 

snapshot

スナップショット

 

ssh

Ssh

 

status

String

 

stop_gluster_service

ブール値

 

storage_domain

StorageDomain

 

storage_domains

StorageDomain[]

 

succeeded

ブール値

 

synchronized_network_attachments

NetworkAttachment[]

 

template

Template

 

ticket

Ticket

 

undeploy_hosted_engine

ブール値

 

use_cloud_init

ブール値

 

use_sysprep

ブール値

 

virtual_functions_configuration

HostNicVirtualFunctionsConfiguration

 

vm

Vm

 

6.3. AffinityGroup struct
リンクのコピー

アフィニティーグループは、定義された関係を持つ仮想マシンのグループを表します。

Expand
表6.3 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

enforcing

ブール値

アフィニティーグループが、そのアフィニティーグループのメンバーである仮想マシンに適用されるアフィニティーのハード強制とソフト強制のどちらを使用するかを指定します。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

positive

ブール値

アフィニティーグループが、そのアフィニティーグループのメンバーである仮想マシンに正のアフィニティーと負のアフィニティーのどちらを適用するか指定します。

Expand
表6.4 リンクの概要
Nameタイプ概要

cluster

Cluster

アフィニティーグループが適用されるクラスターへの参照。

vms

Vm[]

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

6.4. AffinityLabel 構造体
リンクのコピー

アフィニティーラベルは、仮想マシンのスケジューリングに影響を与える可能性があります。利用可能なホストからサブクラスターを作成するために最も頻繁に使用されます。

Expand
表6.5 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

read_only

ブール値

read_only プロパティーは、変更できないラベルをマークします。

6.4.1. read_only
リンクのコピー

read_only プロパティーは、変更できないラベルをマークします。これは通常、内部で生成されたラベルをリストする場合に該当します。

Expand
表6.6 リンクの概要
Nameタイプ概要

hosts

Host[]

このスケジューリングラベルを使用してラベル付けされたホストのリスト。

vms

Vm[]

このスケジューリングラベルを使用してラベル付けされた仮想マシンのリスト。

6.5. Agent 構造体
リンクのコピー

フェンスエージェントを表すタイプ。

Expand
表6.7 属性の概要
Nameタイプ概要

address

String

フェンスエージェントのアドレス。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

concurrent

ブール値

エージェントを同時に使用するか、順次使用するかを指定します。

description

String

プレーンテキストでの人間が判読できる説明。

encrypt_options

ブール値

オプションを暗号化するかどうかを指定します。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

options

Option[]

フェンスエージェントオプション (キーと値のペアのコンマ区切りリスト)。

order

Integer

他のエージェントと一緒に使用する場合のこのエージェントの順序。

password

String

フェンスエージェントのパスワード。

port

Integer

フェンスエージェントのポート。

type

String

フェンスエージェントのタイプ。

username

String

フェンスエージェントのユーザー名。

Expand
表6.8 リンクの概要
Nameタイプ概要

host

ホスト

ホストサービスへの参照。

6.6. AgentConfiguration 構造体
リンクのコピー

Expand
表6.9 属性の概要
Nameタイプ概要

address

String

 

broker_type

MessageBrokerType

 

network_mappings

String

 

password

String

 

port

Integer

 

username

String

 

6.7. Api 構造体
リンクのコピー

このタイプには、API の root サービスによって返される情報が含まれます。

その情報を取得するには、次のようなリクエストを送信します。 

GET /ovirt-engine/api
Copy to Clipboard Toggle word wrap

結果は以下のようになります。 

<api>
  <link rel="hosts" href="/ovirt-engine/api/hosts"/>
  <link rel="vms" href="/ovirt-engine/api/vms"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.1.0_master</full_version>
      <major>4</major>
      <minor>1</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <link rel="templates/blank" href="..."/>
    <link rel="tags/root" href="..."/>
  </special_objects>
  <summary>
    <vms>
      <total>10</total>
      <active>3</active>
    </vms>
    <hosts>
      <total>2</total>
      <active>2</active>
    </hosts>
    <users>
      <total>8</total>
      <active>2</active>
    </users>
    <storage_domains>
      <total>2</total>
      <active>2</active>
    </storage_domains>
  </summary>
  <time>2016-12-12T12:22:25.866+01:00</time>
</api>
Copy to Clipboard Toggle word wrap
Expand
表6.10 属性の概要
Nameタイプ概要

product_info

ProductInfo

製品名、ベンダー名、バージョンなど、製品に関する情報。

special_objects

SpecialObjects

空のテンプレートやタグ階層のルートなどの、特別なオブジェクトへの参照。

summary

ApiSummary

仮想マシン、ホスト、ストレージドメインなどの関連オブジェクトの総数を含む概要。

time

日付

この情報が生成された日時。

6.8. ApiSummary 構造体
リンクのコピー

仮想マシン、ホスト、ストレージドメインなどの関連オブジェクトの総数を含む概要。

Expand
表6.11 属性の概要
Nameタイプ概要

hosts

ApiSummaryItem

ホストの概要。

storage_domains

ApiSummaryItem

ストレージドメインの概要。

users

ApiSummaryItem

ユーザーの概要。

vms

ApiSummaryItem

仮想マシンの概要。

6.9. ApiSummaryItem struct
リンクのコピー

このタイプには、API 概要の項目が含まれます。各項目には、ある種類のオブジェクトの合計数とアクティブな数が含まれています。

Expand
表6.12 属性の概要
Nameタイプ概要

active

Integer

アクティブなオブジェクトの総数。

total

Integer

オブジェクトの総数。

6.10. Application 構造体
リンクのコピー

Expand
表6.13 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.14 リンクの概要
Nameタイプ概要

vm

Vm

 

6.11. アーキテクチャー enum
リンクのコピー

Expand
表6.15 値の概要
Name概要

ppc64

 

undefined

 

x86_64

 

6.12. AuthorizedKey 構造体
リンクのコピー

Expand
表6.16 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

key

String

 

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.17 リンクの概要
Nameタイプ概要

user

User

 

6.13. AutoNumaStatus enum
リンクのコピー

Expand
表6.18 値の概要
Name概要

disable

 

enable

 

unknown

 

6.14. Balance 構造体
リンクのコピー

Expand
表6.19 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.20 リンクの概要
Nameタイプ概要

scheduling_policy

SchedulingPolicy

 

scheduling_policy_unit

SchedulingPolicyUnit

 

6.15. BIOS 構造体
リンクのコピー

Expand
表6.21 属性の概要
Nameタイプ概要

boot_menu

BootMenu

 

6.16. BlockStatistic 構造体
リンクのコピー

Expand
表6.22 属性の概要
Nameタイプ概要

statistics

Statistic[]

 

6.17. Bonding 構造体
リンクのコピー

ネットワークインターフェイスボンドを表します。

Expand
表6.23 属性の概要
Nameタイプ概要

ad_partner_mac

Mac

モード 4 のパートナーボンディングの ad_partner_mac プロパティー。

options

Option[]

ボンディングインターフェイスの option 要素のリスト。

slaves

HostNic[]

結合されたインターフェイスの slave NIC のリスト。

6.17.1. ad_partner_mac
リンクのコピー

モード 4 のパートナーボンディングの ad_partner_mac プロパティー。ボンディングモード 4 は 802.3ad 標準で、動的リンクアグリゲーション(Wikpedia、Presentation )とも呼ばれます。https://en.wikipedia.org/wiki/Link_aggregationad_partner_mac は、ボンディングのもう一方の端にあるシステム (スイッチ) の MAC アドレスです。このパラメーターは読み取り専用です。設定してもボンディングには影響しません。これは、ボンディングが配置されているシステムの /sys/class/net/bondX/bonding/ad_partner_mac ファイルから取得されます。

6.17.2. options
リンクのコピー

ボンディングインターフェイスの option 要素のリスト。各オプションには、プロパティー名と値の属性が含まれています。ボンディングインターフェイスを追加する場合にのみ必要です。

6.17.3. slaves
リンクのコピー

結合されたインターフェイスの slave NIC のリスト。ボンディングインターフェイスを追加する場合にのみ必要です。

6.18. Bookmark 構造体
リンクのコピー

Expand
表6.24 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

value

String

 

6.19. Boot 構造体
リンクのコピー

Expand
表6.25 属性の概要
Nameタイプ概要

devices

BootDevice[]

 

6.20. BootDevice enum
リンクのコピー

Expand
表6.26 値の概要
Name概要

cdrom

 

hd

 

network

 

6.21. BootMenu struct
リンクのコピー

Expand
表6.27 属性の概要
Nameタイプ概要

enabled

ブール値

 

6.22. BootProtocol enum
リンクのコピー

NIC への IP アドレス割り当て方法のオプションを定義します。

Expand
表6.28 値の概要
Name概要

autoconf

ステートレスアドレスの自動設定。

dhcp

Dynamic host configuration protocol (DHCP)

none

アドレス設定なし。

static

静的に定義されたアドレス、マスク、およびゲートウェイ。

6.22.1. autoconf
リンクのコピー

ステートレスアドレスの自動設定。

このメカニズムは RFC 4862 で定義されています。詳細は、こちらの Wipedia の記事 を参照してください。

注記

この値は、IPv6 アドレスに対してのみ有効です。

6.22.2. dhcp
リンクのコピー

Dynamic host configuration protocol (DHCP)

詳細は、こちらの Wipedia の記事 を参照してください。

6.23. BrickProfileDetail 構造体
リンクのコピー

Expand
表6.29 属性の概要
Nameタイプ概要

profile_details

ProfileDetail[]

 
Expand
表6.30 リンクの概要
Nameタイプ概要

brick

GlusterBrick

 

6.24. Cdrom 構造体
リンクのコピー

Expand
表6.31 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

file

File

 

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.32 リンクの概要
Nameタイプ概要

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

6.25. Certificate 構造体
リンクのコピー

Expand
表6.33 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

content

String

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

organization

String

 

subject

String

 

6.26. CloudInit struct
リンクのコピー

Expand
表6.34 属性の概要
Nameタイプ概要

authorized_keys

AuthorizedKey[]

 

files

File[]

 

host

ホスト

 

network_configuration

NetworkConfiguration

 

regenerate_ssh_keys

ブール値

 

timezone

String

 

users

User[]

 

6.27. Cluster 構造体
リンクのコピー

クラスターのタイプの表現。

クラスターの JSON 表現 

{
  "cluster" : [ {
    "ballooning_enabled" : "false",
    "cpu" : {
      "architecture" : "x86_64",
      "type" : "Intel SandyBridge Family"
    },
    "custom_scheduling_policy_properties" : {
      "property" : [ {
        "name" : "HighUtilization",
        "value" : "80"
      }, {
        "name" : "CpuOverCommitDurationMinutes",
        "value" : "2"
      } ]
    },
    "error_handling" : {
      "on_error" : "migrate"
    },
    "fencing_policy" : {
      "enabled" : "true",
      "skip_if_connectivity_broken" : {
        "enabled" : "false",
        "threshold" : "50"
      },
      "skip_if_gluster_bricks_up" : "false",
      "skip_if_gluster_quorum_not_met" : "false",
      "skip_if_sd_active" : {
        "enabled" : "false"
      }
    },
    "gluster_service" : "false",
    "ha_reservation" : "false",
    "ksm" : {
      "enabled" : "true",
      "merge_across_nodes" : "true"
    },
    "maintenance_reason_required" : "false",
    "memory_policy" : {
      "over_commit" : {
        "percent" : "100"
      },
      "transparent_hugepages" : {
        "enabled" : "true"
      }
    },
    "migration" : {
      "auto_converge" : "inherit",
      "bandwidth" : {
        "assignment_method" : "auto"
      },
      "compressed" : "inherit",
      "policy" : {
        "id" : "00000000-0000-0000-0000-000000000000"
      }
    },
    "optional_reason" : "false",
    "required_rng_sources" : {
      "required_rng_source" : [ "random" ]
    },
    "switch_type" : "legacy",
    "threads_as_cores" : "false",
    "trusted_service" : "false",
    "tunnel_migration" : "false",
    "version" : {
      "major" : "4",
      "minor" : "1"
    },
    "virt_service" : "true",
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "mac_pool" : {
      "href" : "/ovirt-engine/api/macpools/456",
      "id" : "456"
    },
    "scheduling_policy" : {
      "href" : "/ovirt-engine/api/schedulingpolicies/789",
      "id" : "789"
    },
    "actions" : {
      "link" : [ {
        "href" : "/ovirt-engine/api/clusters/234/resetemulatedmachine",
        "rel" : "resetemulatedmachine"
      } ]
    },
    "name" : "Default",
    "description" : "The default server cluster",
    "href" : "/ovirt-engine/api/clusters/234",
    "id" : "234",
    "link" : [ {
      "href" : "/ovirt-engine/api/clusters/234/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/cpuprofiles",
      "rel" : "cpuprofiles"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/networkfilters",
      "rel" : "networkfilters"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/networks",
      "rel" : "networks"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/affinitygroups",
      "rel" : "affinitygroups"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/glusterhooks",
      "rel" : "glusterhooks"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/glustervolumes",
      "rel" : "glustervolumes"
    } ]
  } ]
}
Copy to Clipboard Toggle word wrap
Expand
表6.35 属性の概要
Nameタイプ概要

ballooning_enabled

ブール値

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

cpu

Cpu

 

custom_scheduling_policy_properties

Property[]

クラスターのカスタムスケジューリングポリシーのプロパティー。

description

String

プレーンテキストでの人間が判読できる説明。

display

表示

 

error_handling

ErrorHandling

 

fencing_policy

FencingPolicy

クラスターに対してカスタムフェンシングポリシーを定義できます。

gluster_service

ブール値

 

ha_reservation

ブール値

 

id

String

一意の ID

ksm

Ksm

 

maintenance_reason_required

ブール値

 

memory_policy

MemoryPolicy

 

migration

MigrationOptions

 

name

String

人間が判読できるプレーンテキストでの名前。

optional_reason

ブール値

 

required_rng_sources

RngSource[]

 

serial_number

SerialNumber

 

supported_versions

Version[]

 

switch_type

SwitchType

指定されたクラスター内のすべてのネットワークで使用されるスイッチのタイプ。

threads_as_cores

ブール値

 

trusted_service

ブール値

 

tunnel_migration

ブール値

 

version

バージョン

クラスターの互換バージョン。

virt_service

ブール値

 

6.27.1. custom_scheduling_policy_properties
リンクのコピー

クラスターのカスタムスケジューリングポリシーのプロパティー。これらのオプションのプロパティーは、scheduling_policy リンクで指定されたスケジューリングポリシーのプロパティーをオーバーライドし、この特定のクラスターにのみ適用されます。

たとえば、クラスターのカスタムプロパティーを更新するには、以下のリクエストを送信します。 

PUT /ovirt-engine/api/clusters/123
Copy to Clipboard Toggle word wrap

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

<cluster>
  <custom_scheduling_policy_properties>
    <property>
      <name>HighUtilization</name>
      <value>70</value>
    </property>
  </custom_scheduling_policy_properties>
</cluster>
Copy to Clipboard Toggle word wrap

custom_scheduling_policy_properties 属性を使用した更新操作では、scheduling_policy リンクで指定されたスケジューリングポリシーのプロパティーは更新されず、この特定のクラスターにのみ反映されます。

6.27.2. fencing_policy
リンクのコピー

クラスターに対してカスタムフェンシングポリシーを定義できます。

以下に例を示します。 

PUT /ovirt-engine/api/cluster/123
Copy to Clipboard Toggle word wrap

リクエスト本文： 

<cluster>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
  </fencing_policy>
</cluster>
Copy to Clipboard Toggle word wrap

6.27.3. version
リンクのコピー

クラスターの互換バージョン。

このクラスター内のすべてのホストは、少なくともこの互換バージョンをサポートする必要があります。

以下に例を示します。 

GET /ovirt-engine/api/clusters/123
Copy to Clipboard Toggle word wrap

以下を応答します。 

<cluster>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</cluster>
Copy to Clipboard Toggle word wrap

互換バージョンを更新するには、以下を使用します。 

PUT /ovirt-engine/api/clusters/123
Copy to Clipboard Toggle word wrap

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

<cluster>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</cluster>
Copy to Clipboard Toggle word wrap

クラスター互換バージョンを更新するには、クラスター内のすべてのホストが新しい互換バージョンをサポートする必要があります。

Expand
表6.36 リンクの概要
Nameタイプ概要

affinity_groups

AffinityGroup[]

 

cpu_profiles

CpuProfile[]

 

data_center

DataCenter

 

gluster_hooks

GlusterHook[]

 

gluster_volumes

GlusterVolume[]

 

management_network

Network

 

network_filters

NetworkFilter[]

 

networks

Network[]

 

permissions

Permission[]

 

scheduling_policy

SchedulingPolicy

このクラスターによって使用されるデフォルトのスケジューリングポリシーへの参照。

6.28. ClusterLevel 構造体
リンクのコピー

特定のクラスターレベルでサポートされる機能について説明します。

Expand
表6.37 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

cpu_types

CpuType[]

このクラスターレベルでサポートされている CPU タイプ。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

permits

Permit[]

このクラスターレベルでサポートされている permits。

6.29. Configuration 構造体
リンクのコピー

Expand
表6.38 属性の概要
Nameタイプ概要

data

String

仮想マシンを記述するドキュメント。

type

ConfigurationType

 

6.29.1. data
リンクのコピー

仮想マシンを記述するドキュメント。

OVF ドキュメントの例: 

<?xml version='1.0' encoding='UTF-8'?>
<ovf:Envelope xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1/"
  xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
  xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  ovf:version="3.5.0.0">
  <References/>
  <Section xsi:type="ovf:NetworkSection_Type">
    <Info>List of networks</Info>
    <Network ovf:name="Network 1"/>
  </Section>
  <Section xsi:type="ovf:DiskSection_Type">
    <Info>List of Virtual Disks</Info>
  </Section>
  <Content ovf:id="out" xsi:type="ovf:VirtualSystem_Type">
    <CreationDate>2014/12/03 04:25:45</CreationDate>
    <ExportDate>2015/02/09 14:12:24</ExportDate>
    <DeleteProtected>false</DeleteProtected>
    <SsoMethod>guest_agent</SsoMethod>
    <IsSmartcardEnabled>false</IsSmartcardEnabled>
    <TimeZone>Etc/GMT</TimeZone>
    <default_boot_sequence>0</default_boot_sequence>
    <Generation>1</Generation>
    <VmType>1</VmType>
    <MinAllocatedMem>1024</MinAllocatedMem>
    <IsStateless>false</IsStateless>
    <IsRunAndPause>false</IsRunAndPause>
    <AutoStartup>false</AutoStartup>
    <Priority>1</Priority>
    <CreatedByUserId>fdfc627c-d875-11e0-90f0-83df133b58cc</CreatedByUserId>
    <IsBootMenuEnabled>false</IsBootMenuEnabled>
    <IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled>
    <IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled>
    <Name>VM_export</Name>
    <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId>
    <TemplateName>Blank</TemplateName>
    <IsInitilized>false</IsInitilized>
    <Origin>3</Origin>
    <DefaultDisplayType>1</DefaultDisplayType>
    <TrustedService>false</TrustedService>
    <OriginalTemplateId>00000000-0000-0000-0000-000000000000</OriginalTemplateId>
    <OriginalTemplateName>Blank</OriginalTemplateName>
    <UseLatestVersion>false</UseLatestVersion>
    <Section ovf:id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a"
      ovf:required="false"
      xsi:type="ovf:OperatingSystemSection_Type">
      <Info>Guest Operating System</Info>
      <Description>other</Description>
    </Section>
    <Section xsi:type="ovf:VirtualHardwareSection_Type">
      <Info>1 CPU, 1024 Memory</Info>
      <System>
        <vssd:VirtualSystemType>ENGINE 3.5.0.0</vssd:VirtualSystemType>
      </System>
      <Item>
        <rasd:Caption>1 virtual cpu</rasd:Caption>
        <rasd:Description>Number of virtual CPU</rasd:Description>
        <rasd:InstanceId>1</rasd:InstanceId>
        <rasd:ResourceType>3</rasd:ResourceType>
        <rasd:num_of_sockets>1</rasd:num_of_sockets>
        <rasd:cpu_per_socket>1</rasd:cpu_per_socket>
      </Item>
      <Item>
        <rasd:Caption>1024 MB of memory</rasd:Caption>
        <rasd:Description>Memory Size</rasd:Description>
        <rasd:InstanceId>2</rasd:InstanceId>
        <rasd:ResourceType>4</rasd:ResourceType>
        <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
        <rasd:VirtualQuantity>1024</rasd:VirtualQuantity>
      </Item>
      <Item>
        <rasd:Caption>USB Controller</rasd:Caption>
        <rasd:InstanceId>3</rasd:InstanceId>
        <rasd:ResourceType>23</rasd:ResourceType>
        <rasd:UsbPolicy>DISABLED</rasd:UsbPolicy>
      </Item>
    </Section>
  </Content>
</ovf:Envelope>
Copy to Clipboard Toggle word wrap

6.30. ConfigurationType enum
リンクのコピー

Expand
表6.39 値の概要
Name概要

ovf

 

6.31. Console 構造体
リンクのコピー

Expand
表6.40 属性の概要
Nameタイプ概要

enabled

ブール値

 

6.32. Core 構造体
リンクのコピー

Expand
表6.41 属性の概要
Nameタイプ概要

index

Integer

 

socket

Integer

 

6.33. CPU 構造体
リンクのコピー

Expand
表6.42 属性の概要
Nameタイプ概要

architecture

アーキテクチャー

 

cores

Core[]

 

cpu_tune

CpuTune

 

level

Integer

 

mode

CpuMode

 

name

String

 

speed

10 進数

 

topology

CpuTopology

 

type

String

 

6.34. CpuMode enum
リンクのコピー

Expand
表6.43 値の概要
Name概要

custom

 

host_model

 

host_passthrough

 

6.35. CpuProfile 構造体
リンクのコピー

Expand
表6.44 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.45 リンクの概要
Nameタイプ概要

cluster

Cluster

 

permissions

Permission[]

 

qos

Qos

 

6.36. CpuTopology 構造体
リンクのコピー

Expand
表6.46 属性の概要
Nameタイプ概要

cores

Integer

 

sockets

Integer

 

threads

Integer

 

6.37. CpuTune 構造体
リンクのコピー

Expand
表6.47 属性の概要
Nameタイプ概要

vcpu_pins

VcpuPin[]

 

6.38. CpuType 構造体
リンクのコピー

サポートされている CPU タイプを記述します。

Expand
表6.48 属性の概要
Nameタイプ概要

architecture

アーキテクチャー

CPU のアーキテクチャー。

level

Integer

CPU タイプのレベル。

name

String

CPU タイプの名前（例： Intel Conroe Family ）。

6.39. CreationStatus enum
リンクのコピー

Expand
表6.49 値の概要
Name概要

完了

 

failed

 

in_progress

 

pending

 

6.40. CustomProperty 構造体
リンクのコピー

Expand
表6.50 属性の概要
Nameタイプ概要

name

String

 

regexp

String

 

value

String

 

6.41. DataCenter 構造体
リンクのコピー

Expand
表6.51 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

local

ブール値

 

name

String

人間が判読できるプレーンテキストでの名前。

quota_mode

QuotaModeType

 

status

DataCenterStatus

 

storage_format

StorageFormat

 

supported_versions

Version[]

 

version

バージョン

データセンターの互換バージョン。

6.41.1. version
リンクのコピー

データセンターの互換バージョン。

このデータセンター内のすべてのクラスターは、少なくともこの互換バージョンに設定されている必要があります。

以下に例を示します。 

GET /ovirt-engine/api/datacenters/123
Copy to Clipboard Toggle word wrap

以下を応答します。 

<data_center>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</data_center>
Copy to Clipboard Toggle word wrap

互換バージョンを更新するには、以下を使用します。 

PUT /ovirt-engine/api/datacenters/123
Copy to Clipboard Toggle word wrap

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

<data_center>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</data_center>
Copy to Clipboard Toggle word wrap
Expand
表6.52 リンクの概要
Nameタイプ概要

clusters

Cluster[]

このデータセンター内のクラスターへの参照。

iscsi_bonds

IscsiBond[]

このデータセンターによって使用される ISCSI ボンディングへの参照。

mac_pool

MacPool

このデータセンターによって使用される MAC プールへの参照。

networks

Network[]

このデータセンターに接続されたネットワークへの参照。

permissions

Permission[]

このデータセンターに割り当てられたパーミッションへの参照。

qoss

qos[]

このデータセンターが使用する QoS への参照。

quotas

Quota[]

このデータセンターに割り当てられたクォータへの参照。

storage_domains

StorageDomain[]

このデータセンターに割り当てられたストレージドメインへの参照。

6.42. DataCenterStatus enum
リンクのコピー

Expand
表6.53 値の概要
Name概要

contend

 

maintenance

 

not_operational

 

problematic

 

uninitialized

 

up

 

6.43. Device 構造体
リンクのコピー

デバイスは、デバイスの潜在的な親へのリンクをラップします。

Expand
表6.54 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.55 リンクの概要
Nameタイプ概要

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

6.44. Disk 構造体
リンクのコピー

仮想ディスクデバイスを表します。

Expand
表6.56 属性の概要
Nameタイプ概要

active

ブール値

ディスクが仮想マシンから見えるかどうかを示します。

actual_size

Integer

ディスクの実際のサイズ (バイト単位)。

alias

String

 

bootable

ブール値

ディスクが起動可能としてマークされているかどうかを示します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

format

DiskFormat

基礎となるストレージフォーマット。

id

String

一意の ID

image_id

String

 

interface

DiskInterface

ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。

logical_name

String

 

lun_storage

HostStorage

 

name

String

人間が判読できるプレーンテキストでの名前。

propagate_errors

ブール値

ディスクエラーによって仮想マシンを一時停止すべきでないかどうかを示します。代わりに、ディスクエラーをゲストオペレーティングシステムに伝播する必要があるかどうかを示します。

provisioned_size

Integer

ディスクの仮想サイズ (バイト単位)。

read_only

ブール値

ディスクが読み取り専用モードかどうかを示します。

sgio

ScsiGenericIO

 

shareable

ブール値

ディスクを複数の仮想マシンに接続できるかどうかを示します。

sparse

ブール値

ディスクの物理ストレージの事前割り当てを避けるべきかどうかを示します。

status

DiskStatus

ディスクデバイスのステータス。

storage_type

DiskStorageType

 

uses_scsi_reservation

ブール値

 

wipe_after_delete

ブール値

削除後にディスクのブロックがゼロとして読み戻されるかどうかを示します。

- ブロックストレージでは、ディスクはゼロにならなければ削除できません。

6.44.1. active
リンクのコピー

ディスクが仮想マシンから見えるかどうかを示します。

重要

仮想マシンにディスクアタッチメントを追加する場合、サーバーはこの属性を含まない要求を受け入れますが、効果は定義されません。場合によっては、ディスクが自動的にアクティベートされ、その他の場合は自動的にアクティブになりません。問題を回避するには、常に希望の値でこの属性をふくめることを強く推奨します。

6.44.2. actual_size
リンクのコピー

ディスクの実際のサイズ (バイト単位)。

実際のサイズは、ディスクによって実際に使用されるバイト数であり、cow 形式を使用するディスクのプロビジョニングされたサイズよりも小さくなります。

6.44.3. bootable
リンクのコピー

ディスクが起動可能としてマークされているかどうかを示します。

重要

この属性は、実際に仮想マシンに接続されているディスクに対してのみ意味があり、API のバージョン 4 では、DiskAttachment タイプに移動されています。ここでは後方互換性のためにのみ保持されており、将来的には削除される予定です。

6.44.4. interface
リンクのコピー

ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。

重要

この属性は、実際に仮想マシンに接続されているディスクに対してのみ意味があり、API のバージョン 4 では、DiskAttachment タイプに移動されています。ここでは後方互換性のためにのみ保持されており、将来的には削除される予定です。

6.44.5. provisioned_size
リンクのコピー

ディスクの仮想サイズ (バイト単位)。

新しいディスクを作成する場合、この属性は必須です。

6.44.6. shareable
リンクのコピー

ディスクを複数の仮想マシンに接続できるかどうかを示します。

重要

ディスクが複数の仮想マシンに接続されている場合、GlusterFS や GFS などの共有ファイルシステムを使用するなど、データの破損を回避するために、それらの仮想マシンのゲストオペレーティングシステムがアクセスを調整する責任があります。

6.44.7. wipe_after_delete
リンクのコピー

削除後にディスクのブロックがゼロとして読み戻されるかどうかを示します。

  • ブロックストレージでは、ディスクはゼロにならなければ削除できません。
  • ファイルストレージでは、以前に削除されたブロックがゼロとして読み戻されることがファイルシステムによって既に保証されているため、ディスクはすぐに削除されます。
Expand
表6.57 リンクの概要
Nameタイプ概要

disk_profile

DiskProfile

 

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

openstack_volume_type

OpenStackVolumeType

 

permissions

Permission[]

 

quota

クォータ

 

snapshot

スナップショット

 

statistics

Statistic[]

ディスクによって公開される統計。

storage_domain

StorageDomain

 

storage_domains

StorageDomain[]

このディスクに関連付けられているストレージドメイン。

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

6.45. DiskAttachment 構造体
リンクのコピー

ディスクを仮想マシンに接続する方法について記述します。

Expand
表6.58 属性の概要
Nameタイプ概要

active

ブール値

このフラグは、ディスクが接続されている仮想マシンでアクティブであるかどうかを示します。

bootable

ブール値

ディスクが起動可能かどうかを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

interface

DiskInterface

ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。

logical_name

String

仮想マシンの内部から見た、仮想マシンのディスクの論理名。

name

String

人間が判読できるプレーンテキストでの名前。

6.45.1. active
リンクのコピー

このフラグは、ディスクが接続されている仮想マシンでアクティブであるかどうかを示します。

アクティブステータスの仮想マシンにアタッチされているディスクは、実行時に仮想マシンに接続され、使用することができます。

6.45.2. logical_name
リンクのコピー

仮想マシンの内部から見た、仮想マシンのディスクの論理名。

ディスクの論理名は、ゲストエージェントが仮想マシン内にインストールされて実行されている場合にのみ報告されます。

たとえば、ゲストオペレーティングシステムが Linux で、ディスクが VirtIO インターフェイスを介して接続されている場合、論理名は /dev/vda として報告されます。 

<disk_attachment>
  ...
  <logical_name>/dev/vda</logical_name>
</disk_attachment>
Copy to Clipboard Toggle word wrap

ゲストゲストオペレーティングシステムが Windows の場合、論理名は \\.\PHYSICALDRIVE0 として報告されます。

Expand
表6.59 リンクの概要
Nameタイプ概要

disk

ディスク

ディスクへの参照。

template

Template

テンプレートへの参照。

vm

Vm

仮想マシンへの参照。

6.46. DiskFormat enum
リンクのコピー

ディスクの基礎となるストレージフォーマット。

Expand
表6.60 値の概要
Name概要

cow

Copy On Write フォーマットでは、パフォーマンスのオーバーヘッドが小さいスナップショットが可能です。

raw

raw フォーマットではスナップショットは許可されませんが、パフォーマンスが向上します。

6.47. DiskInterface enum
リンクのコピー

Expand
表6.61 値の概要
Name概要

ide

 

spapr_vscsi

 

virtio

 

virtio_scsi

 

6.48. DiskProfile struct
リンクのコピー

Expand
表6.62 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.63 リンクの概要
Nameタイプ概要

permissions

Permission[]

 

qos

Qos

 

storage_domain

StorageDomain

 

6.49. DiskSnapshot 構造体
リンクのコピー

Expand
表6.64 属性の概要
Nameタイプ概要

active

ブール値

ディスクが仮想マシンから見えるかどうかを示します。

actual_size

Integer

ディスクの実際のサイズ (バイト単位)。

alias

String

 

bootable

ブール値

ディスクが起動可能としてマークされているかどうかを示します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

format

DiskFormat

基礎となるストレージフォーマット。

id

String

一意の ID

image_id

String

 

interface

DiskInterface

ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。

logical_name

String

 

lun_storage

HostStorage

 

name

String

人間が判読できるプレーンテキストでの名前。

propagate_errors

ブール値

ディスクエラーによって仮想マシンを一時停止すべきでないかどうかを示します。代わりに、ディスクエラーをゲストオペレーティングシステムに伝播する必要があるかどうかを示します。

provisioned_size

Integer

ディスクの仮想サイズ (バイト単位)。

read_only

ブール値

ディスクが読み取り専用モードかどうかを示します。

sgio

ScsiGenericIO

 

shareable

ブール値

ディスクを複数の仮想マシンに接続できるかどうかを示します。

sparse

ブール値

ディスクの物理ストレージの事前割り当てを避けるべきかどうかを示します。

status

DiskStatus

ディスクデバイスのステータス。

storage_type

DiskStorageType

 

uses_scsi_reservation

ブール値

 

wipe_after_delete

ブール値

削除後にディスクのブロックがゼロとして読み戻されるかどうかを示します。

- ブロックストレージでは、ディスクはゼロにならなければ削除できません。

6.49.1. active
リンクのコピー

ディスクが仮想マシンから見えるかどうかを示します。

重要

仮想マシンにディスクアタッチメントを追加する場合、サーバーはこの属性を含まない要求を受け入れますが、効果は定義されません。場合によっては、ディスクが自動的にアクティベートされ、その他の場合は自動的にアクティブになりません。問題を回避するには、常に希望の値でこの属性をふくめることを強く推奨します。

6.49.2. actual_size
リンクのコピー

ディスクの実際のサイズ (バイト単位)。

実際のサイズは、ディスクによって実際に使用されるバイト数であり、cow 形式を使用するディスクのプロビジョニングされたサイズよりも小さくなります。

6.49.3. bootable
リンクのコピー

ディスクが起動可能としてマークされているかどうかを示します。

重要

この属性は、実際に仮想マシンに接続されているディスクに対してのみ意味があり、API のバージョン 4 では、DiskAttachment タイプに移動されています。ここでは後方互換性のためにのみ保持されており、将来的には削除される予定です。

6.49.4. interface
リンクのコピー

ディスクデバイスを仮想マシンに接続するために使用されるインターフェイスドライバーのタイプ。

重要

この属性は、実際に仮想マシンに接続されているディスクに対してのみ意味があり、API のバージョン 4 では、DiskAttachment タイプに移動されています。ここでは後方互換性のためにのみ保持されており、将来的には削除される予定です。

6.49.5. provisioned_size
リンクのコピー

ディスクの仮想サイズ (バイト単位)。

新しいディスクを作成する場合、この属性は必須です。

6.49.6. shareable
リンクのコピー

ディスクを複数の仮想マシンに接続できるかどうかを示します。

重要

ディスクが複数の仮想マシンに接続されている場合、GlusterFS や GFS などの共有ファイルシステムを使用するなど、データの破損を回避するために、それらの仮想マシンのゲストオペレーティングシステムがアクセスを調整する責任があります。

6.49.7. wipe_after_delete
リンクのコピー

削除後にディスクのブロックがゼロとして読み戻されるかどうかを示します。

  • ブロックストレージでは、ディスクはゼロにならなければ削除できません。
  • ファイルストレージでは、以前に削除されたブロックがゼロとして読み戻されることがファイルシステムによって既に保証されているため、ディスクはすぐに削除されます。
Expand
表6.65 リンクの概要
Nameタイプ概要

disk

ディスク

 

disk_profile

DiskProfile

 

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

openstack_volume_type

OpenStackVolumeType

 

permissions

Permission[]

 

quota

クォータ

 

snapshot

スナップショット

 

statistics

Statistic[]

ディスクによって公開される統計。

storage_domain

StorageDomain

 

storage_domains

StorageDomain[]

このディスクに関連付けられているストレージドメイン。

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

6.50. DiskStatus enum
リンクのコピー

Expand
表6.66 値の概要
Name概要

illegal

 

locked

 

ok

 

6.51. DiskStorageType enum
リンクのコピー

Expand
表6.67 値の概要
Name概要

cinder

 

image

 

lun

 

6.52. DiskType enum
リンクのコピー

Expand
表6.68 値の概要
Name概要

data

 

system

 

6.53. Display 構造体
リンクのコピー

Expand
表6.69 属性の概要
Nameタイプ概要

address

String

 

allow_override

ブール値

 

certificate

証明書

 

copy_paste_enabled

ブール値

 

disconnect_action

String

 

file_transfer_enabled

ブール値

 

keyboard_layout

String

 

monitors

Integer

 

port

Integer

 

proxy

String

 

secure_port

Integer

 

single_qxl_pci

ブール値

 

smartcard_enabled

ブール値

 

type

DisplayType

 

6.54. DisplayType enum
リンクのコピー

Expand
表6.70 値の概要
Name概要

spice

 

vnc

 

6.55. Dns 構造体
リンクのコピー

DNS リゾルバー設定を表します。

Expand
表6.71 属性の概要
Nameタイプ概要

search_domains

Host[]

検索ドメインとして機能するホストの配列。

servers

Host[]

DNS サーバーとして機能するホストの配列。

6.56. Domain 構造体
リンクのコピー

このタイプは、ディレクトリーサービスドメインを表します。

Expand
表6.72 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

user

User

 
Expand
表6.73 リンクの概要
Nameタイプ概要

groups

Group[]

ディレクトリーサービス内のすべてのグループへの参照。

users

User[]

ディレクトリーサービス内のすべてのユーザー一覧への参照。

6.57. EntityExternalStatus enum
リンクのコピー

外部エンティティーのステータスを表すタイプ。

Expand
表6.74 値の概要
Name概要

error

外部エンティティーのステータスに誤りがあります。

failure

外部エンティティーに障害の原因となる問題があります。

info

外部エンティティーのステータスは問題ありませんが、関連する可能性のある情報がいくつかあります。

ok

外部エンティティーのステータスは問題ありません。

warning

外部エンティティーのステータスは問題ありませんが、注意が必要な問題があります。

6.57.1. error
リンクのコピー

外部エンティティーのステータスに誤りがあります。これには、適度な注意が必要な場合があります。

6.57.2. failure
リンクのコピー

外部エンティティーに障害の原因となる問題があります。すぐに注意が必要な場合があります。

6.58. EntityProfileDetail struct
リンクのコピー

Expand
表6.75 属性の概要
Nameタイプ概要

profile_details

ProfileDetail[]

 

6.59. ErrorHandling 構造体
リンクのコピー

Expand
表6.76 属性の概要
Nameタイプ概要

on_error

MigrateOnError

 

6.60. Event 構造体
リンクのコピー

イベントを表すタイプ。

Expand
表6.77 属性の概要
Nameタイプ概要

code

Integer

イベントコード。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

correlation_id

String

イベント相関識別子。

custom_data

String

カスタムイベントデータを表すフリーテキスト。

custom_id

Integer

カスタムイベント識別子。

description

String

プレーンテキストでの人間が判読できる説明。

flood_rate

Integer

フラッドレートを定義します。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

origin

String

イベントの発生源を特定するフリーテキスト。

severity

LogSeverity

イベントの重大度。

time

日付

イベント時間。

6.60.1. correlation_id
リンクのコピー

イベント相関識別子。複数のイベントを相互に関連付けるために使用されます。

6.60.2. flood_rate
リンクのコピー

フラッドレートを定義します。これにより、定義されたレートでイベントが複数回発生した場合のフラッディングが防止されます。デフォルトは 30 秒です。

Expand
表6.78 リンクの概要
Nameタイプ概要

cluster

Cluster

クラスターサービスへの参照。

data_center

DataCenter

データセンターサービスへの参照。

host

ホスト

ホストサービスへの参照。

storage_domain

StorageDomain

ストレージドメインサービスへの参照。

template

Template

テンプレートサービスへの参照。

user

User

ユーザーサービスへの参照。

vm

Vm

仮想マシンサービスへの参照。

6.61. ExternalComputeResource struct
リンクのコピー

Expand
表6.79 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

provider

String

 

url

String

 

user

String

 
Expand
表6.80 リンクの概要
Nameタイプ概要

external_host_provider

ExternalHostProvider

 

6.62. ExternalDiscoveredHost struct
リンクのコピー

Expand
表6.81 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

ip

String

 

last_report

String

 

mac

String

 

name

String

人間が判読できるプレーンテキストでの名前。

subnet_name

String

 
Expand
表6.82 リンクの概要
Nameタイプ概要

external_host_provider

ExternalHostProvider

 

6.63. ExternalHost 構造体
リンクのコピー

Expand
表6.83 属性の概要
Nameタイプ概要

address

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.84 リンクの概要
Nameタイプ概要

external_host_provider

ExternalHostProvider

 

6.64. ExternalHostGroup struct
リンクのコピー

Expand
表6.85 属性の概要
Nameタイプ概要

architecture_name

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

domain_name

String

 

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

operating_system_name

String

 

subnet_name

String

 
Expand
表6.86 リンクの概要
Nameタイプ概要

external_host_provider

ExternalHostProvider

 

6.65. ExternalHostProvider struct
リンクのコピー

Expand
表6.87 属性の概要
Nameタイプ概要

authentication_url

String

外部プロバイダー認証 URL アドレスを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

password

String

認証プロセス中にユーザーのパスワードを定義します。

properties

Property[]

プロバイダー名/値のプロパティーの配列。

requires_authentication

ブール値

プロバイダー認証が必要かどうかを定義します。

url

String

外部プロバイダーの URL アドレスを定義します。

username

String

認証プロセス中に使用されるユーザー名を定義します。

6.65.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

Expand
表6.88 リンクの概要
Nameタイプ概要

certificates

Certificate[]

 

compute_resources

ExternalComputeResource[]

 

discovered_hosts

ExternalDiscoveredHost[]

 

host_groups

ExternalHostGroup[]

 

hosts

Host[]

 

6.66. ExternalProvider 構造体
リンクのコピー

外部プロバイダーを表します。

Expand
表6.89 属性の概要
Nameタイプ概要

authentication_url

String

外部プロバイダー認証 URL アドレスを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

password

String

認証プロセス中にユーザーのパスワードを定義します。

properties

Property[]

プロバイダー名/値のプロパティーの配列。

requires_authentication

ブール値

プロバイダー認証が必要かどうかを定義します。

url

String

外部プロバイダーの URL アドレスを定義します。

username

String

認証プロセス中に使用されるユーザー名を定義します。

6.66.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

6.67. ExternalStatus enum
リンクのコピー

Expand
表6.90 値の概要
Name概要

error

 

failure

 

info

 

ok

 

warning

 

6.68. ExternalSystemType enum
リンクのコピー

step に関連する外部システムの種類を表す。

Expand
表6.91 値の概要
Name概要

gluster

step に関連する外部システムとして Gluster を表現する。

vdsm

step に関連する外部システムとして VDSM を表現する。

6.69. ExternalVmImport struct
リンクのコピー

外部システムからの仮想マシンインポート操作のパラメーターについて説明します。

Expand
表6.92 属性の概要
Nameタイプ概要

name

String

外部システム内で定義されているようにインポートする仮想マシンの名前。

password

String

外部ハイパーバイザーシステムに対して認証するためのパスワード。

provider

ExternalVmProviderType

外部仮想マシンプロバイダーのタイプ。

sparse

ブール値

結果の仮想マシンのディスク割り当てポリシーを指定します。スパースの場合は true、事前割り当ての場合は false を指定します。

url

String

変換用に virt-v2v ツールに渡される URL。

username

String

外部ハイパーバイザーシステムに対して認証するためのユーザー名。

6.69.1. url
リンクのコピー

変換用に virt-v2v ツールに渡される URL。

以下に例を示します。 

vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1
Copy to Clipboard Toggle word wrap

その他の例は、http://libguestfs.org/virt-v2v.1.html を参照してください。

Expand
表6.93 リンクの概要
Nameタイプ概要

cluster

Cluster

結果の仮想マシンのターゲットクラスターを指定します。

cpu_profile

CpuProfile

オプションで、結果の仮想マシンの cpu プロファイルを指定します。

drivers_iso

File

virt-v2v 変換プロセス中に使用できる ISO 伝送ドライバーのオプションの名前。

host

ホスト

変換プロセスに使用するホストのオプションの指定（ホストの ID を使用）。

quota

クォータ

オプションで、結果の仮想マシンに適用されるクォータを指定します。

storage_domain

StorageDomain

変換されたディスクのターゲットストレージドメインを指定します。

vm

Vm

新しく作成された仮想マシンの名前を指定するために使用される仮想マシンエンティティー。

6.70. ExternalVmProviderType enum
リンクのコピー

外部ハイパーバイザーシステムのタイプについて説明します。

Expand
表6.94 値の概要
Name概要

kvm

 

vmware

 

xen

 

6.71. Fault 構造体
リンクのコピー

Expand
表6.95 属性の概要
Nameタイプ概要

detail

String

 

reason

String

 

6.72. FenceType enum
リンクのコピー

フェンス操作のタイプを表すタイプ。

Expand
表6.96 値の概要
Name概要

manual

電源管理を介した手動のホストフェンシング。

restart

電源管理を介してホストを再起動します。

start

電源管理を介してホストを起動します。

status

電源管理を介してホストの電源ステータスを確認します。

stop

電源管理を介してホストを停止します。

6.73. FencingPolicy 構造体
リンクのコピー

クラスターフェンシングポリシーを表すタイプ。

Expand
表6.97 属性の概要
Nameタイプ概要

enabled

ブール値

このクラスターでフェンシングを有効または無効にします。

skip_if_connectivity_broken

SkipIfConnectivityBroken

有効にすると、クラスター内の設定可能なパーセンテージを超えるホストが接続を失ってもホストのフェンシングは実行されません。

skip_if_sd_active

SkipIfSdActive

有効にすると、ホストがストレージでリースを維持している場合にフェンシングをスキップします。

6.73.1. skip_if_connectivity_broken
リンクのコピー

有効にすると、クラスター内の設定可能なパーセンテージを超えるホストが接続を失ってもホストのフェンシングは実行されません。これは、クラスター内でグローバルネットワークの問題が発生した場合にフェンシング ストーム を防ぐためです。

6.73.2. skip_if_sd_active
リンクのコピー

有効にすると、ホストがストレージでリースを維持している場合にフェンシングをスキップします。これは、ホストがまだストレージにアクセスできる場合、フェンシングされないことを意味します。

6.74. File 構造体
リンクのコピー

Expand
表6.98 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

content

String

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

type

String

 
Expand
表6.99 リンクの概要
Nameタイプ概要

storage_domain

StorageDomain

 

6.75. Filter 構造体
リンクのコピー

Expand
表6.100 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

position

Integer

 
Expand
表6.101 リンクの概要
Nameタイプ概要

scheduling_policy_unit

SchedulingPolicyUnit

 

6.76. Floppy 構造体
リンクのコピー

Expand
表6.102 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

file

File

 

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.103 リンクの概要
Nameタイプ概要

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

6.77. FopStatistic struct
リンクのコピー

Expand
表6.104 属性の概要
Nameタイプ概要

name

String

 

statistics

Statistic[]

 

6.78. GlusterBrick 構造体
リンクのコピー

Expand
表6.105 属性の概要
Nameタイプ概要

brick_dir

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

device

String

 

fs_name

String

 

gluster_clients

GlusterClient[]

 

id

String

一意の ID

memory_pools

GlusterMemoryPool[]

 

mnt_options

String

 

name

String

人間が判読できるプレーンテキストでの名前。

pid

Integer

 

port

Integer

 

server_id

String

 

status

GlusterBrickStatus

 
Expand
表6.106 リンクの概要
Nameタイプ概要

gluster_volume

GlusterVolume

 

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

statistics

Statistic[]

 

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

6.79. GlusterBrickAdvancedDetails struct
リンクのコピー

Expand
表6.107 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

device

String

 

fs_name

String

 

gluster_clients

GlusterClient[]

 

id

String

一意の ID

memory_pools

GlusterMemoryPool[]

 

mnt_options

String

 

name

String

人間が判読できるプレーンテキストでの名前。

pid

Integer

 

port

Integer

 
Expand
表6.108 リンクの概要
Nameタイプ概要

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

6.80. GlusterBrickMemoryInfo struct
リンクのコピー

Expand
表6.109 属性の概要
Nameタイプ概要

memory_pools

GlusterMemoryPool[]

 

6.81. GlusterBrickStatus enum
リンクのコピー

Expand
表6.110 値の概要
Name概要

down

ブリックは down 状態です。データを保存したり、ブリックから取得したりできません。

unknown

ホストが応答していないため、ステータスを判別できない場合。

up

ブリックは up 状態にあり、データを保存したり、ブリックから取得したりできます。

6.82. GlusterClient 構造体
リンクのコピー

Expand
表6.111 属性の概要
Nameタイプ概要

bytes_read

Integer

 

bytes_written

Integer

 

client_port

Integer

 

host_name

String

 

6.83. GlusterHook struct
リンクのコピー

Expand
表6.112 属性の概要
Nameタイプ概要

checksum

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

conflict_status

Integer

 

conflicts

String

 

content

String

 

content_type

HookContentType

 

description

String

プレーンテキストでの人間が判読できる説明。

gluster_command

String

 

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

stage

HookStage

 

status

GlusterHookStatus

 
Expand
表6.113 リンクの概要
Nameタイプ概要

cluster

Cluster

 

server_hooks

GlusterServerHook[]

 

6.84. GlusterHookStatus enum
リンクのコピー

Expand
表6.114 値の概要
Name概要

disabled

クラスターでフックが無効になっています。

enabled

クラスターでフックが有効になっています。

missing

フックのステータスが不明/欠落しています。

6.85. GlusterMemoryPool struct
リンクのコピー

Expand
表6.115 属性の概要
Nameタイプ概要

alloc_count

Integer

 

cold_count

Integer

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

hot_count

Integer

 

id

String

一意の ID

max_alloc

Integer

 

max_stdalloc

Integer

 

name

String

人間が判読できるプレーンテキストでの名前。

padded_size

Integer

 

pool_misses

Integer

 

type

String

 

6.86. GlusterServerHook struct
リンクのコピー

Expand
表6.116 属性の概要
Nameタイプ概要

checksum

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

content_type

HookContentType

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

status

GlusterHookStatus

 
Expand
表6.117 リンクの概要
Nameタイプ概要

host

ホスト

 

6.87. GlusterState enum
リンクのコピー

Expand
表6.118 値の概要
Name概要

down

 

unknown

 

up

 

6.88. GlusterVolume 構造体
リンクのコピー

Expand
表6.119 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

disperse_count

Integer

 

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

options

Option[]

 

redundancy_count

Integer

 

replica_count

Integer

 

status

GlusterVolumeStatus

 

stripe_count

Integer

 

transport_types

TransportType[]

 

volume_type

GlusterVolumeType

 
Expand
表6.120 リンクの概要
Nameタイプ概要

bricks

GlusterBrick[]

 

cluster

Cluster

 

statistics

Statistic[]

 

6.89. GlusterVolumeProfileDetails struct
リンクのコピー

Expand
表6.121 属性の概要
Nameタイプ概要

brick_profile_details

BrickProfileDetail[]

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

nfs_profile_details

NfsProfileDetail[]

 

6.90. GlusterVolumeStatus enum
リンクのコピー

Expand
表6.122 値の概要
Name概要

down

クライアントがボリュームをマウントして使用できるようにするには、ボリュームを開始する必要があります。

unknown

ホストが応答していないため、ステータスを判別できない場合。

up

ボリュームが開始され、クライアントによるマウントおよび使用が可能です。

6.91. GlusterVolumeType enum
リンクのコピー

Gluster ボリュームのタイプを表すタイプ。

Expand
表6.123 値の概要
Name概要

disperse

分散ボリュームは消去コードに基づいており、ディスクまたはサーバーの障害に対するスペース効率の高い保護を提供します。

distribute

分散ボリュームは、ボリューム内のブリック全体にファイルを分散します。

distributed_disperse

Distributed dispersed ボリュームは、分散サブボリューム全体にファイルを分散します。

distributed_replicate

Distributed replicated ボリュームは、ボリューム内の複製ブリック全体にファイルを分散します。

distributed_stripe

Distributed striped ボリュームは、クラスター内の 2 つ以上のノードにデータをストライプします。

distributed_striped_replicate

Distributed striped replicated ボリュームは、クラスター内の複製ブリック全体にストライプデータを分散します。

replicate

複製されたボリュームは、ボリューム内のブリック全体でファイルをレプリケートします。

stripe

Striped ボリュームは、ボリューム内のブリック全体にデータをストライプします。

striped_replicate

Striped replicated ボリュームは、クラスター内のレプリケートされたブリック全体にデータをストライプします。

6.91.1. disperse
リンクのコピー

Dispersed ボリュームは消去コードに基づいており、ディスクまたはサーバーの障害に対するスペース効率の高い保護を提供します。

元のファイルのエンコードされたフラグメントを各ブリックに分散させ、元のファイルを復元するためにフラグメントのサブセットのみが必要になるようにします。データへのアクセスを失わずに喪失するブリックの数は、ボリュームの作成時に管理者によって設定されます。

6.91.2. distribute
リンクのコピー

分散ボリュームは、ボリューム内のブリック全体にファイルを分散します。

Distributed ボリュームは、ストレージのスケーリングを必要とし、冗長性が重要でないか、他のハードウェア/ソフトウェア層によって提供される場合に使用できます。

6.91.3. distributed_disperse
リンクのコピー

Distributed dispersed ボリュームは、分散サブボリューム全体にファイルを分散します。

これには、distribute replicate ボリュームと同じ利点がありますが、disperse を使用してデータをブリックに格納します。

6.91.4. distributed_replicate
リンクのコピー

Distributed replicated ボリュームは、ボリューム内の複製ブリック全体にファイルを分散します。

ストレージのスケーリングに必要で、信頼性を高く保つことが重要な環境で、分散レプリケーションボリュームを使用できます。また、分散レプリケートされたボリュームは、ほとんどの環境で読み取りパフォーマンスも向上します。

6.91.5. distributed_stripe
リンクのコピー

Distributed striped ボリュームは、クラスター内の 2 つ以上のノードにデータをストライプします。

Distributed striped ボリュームは、ストレージのスケーリングが必要で、非常に大きなファイルにアクセスする同時実行性の高い環境が不可欠な場合に使用する必要があります。

注記: Glusterfs 3.7 リリースでのシャーディングの導入により、striped ボリュームは非推奨となり、今後のリリースで削除される予定です。

6.91.6. distributed_striped_replicate
リンクのコピー

Distributed striped replicated ボリュームは、クラスター内の複製ブリック全体にストライプデータを分散します。

最良の結果を得るために、非常に大きなファイルへの並列アクセスとパフォーマンスが重要な同時実行性の高い環境では、distributed striped replicated ボリュームを使用する必要があります。

注記: Glusterfs 3.7 リリースでのシャーディングの導入により、striped ボリュームは非推奨となり、今後のリリースで削除される予定です。

6.91.7. replicate
リンクのコピー

複製されたボリュームは、ボリューム内のブリック全体でファイルをレプリケートします。

レプリケーションされたボリュームは、高可用性と高信頼性が重要な環境で使用できます。

6.91.8. stripe
リンクのコピー

Striped ボリュームは、ボリューム内のブリック全体にデータをストライプします。

最良の結果を得るには、striped ボリュームは、非常に大きなファイルにアクセスする同時実行性の高い環境でのみ使用する必要があります。

注記: Glusterfs 3.7 リリースでのシャーディングの導入により、striped ボリュームは非推奨となり、今後のリリースで削除される予定です。

6.91.9. striped_replicate
リンクのコピー

Striped replicated ボリュームは、クラスター内のレプリケートされたブリック全体にデータをストライプします。

最良の結果を得るために、非常に大きなファイルへの並列アクセスが発生し、パフォーマンスが重要な同時実行性の高い環境では、striped replicated ボリュームを使用する必要があります。

注記: Glusterfs 3.7 リリースでのシャーディングの導入により、striped ボリュームは非推奨となり、今後のリリースで削除される予定です。

6.92. GracePeriod 構造体
リンクのコピー

Expand
表6.124 属性の概要
Nameタイプ概要

expiry

Integer

 

6.93. GraphicsConsole 構造体
リンクのコピー

Expand
表6.125 属性の概要
Nameタイプ概要

address

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

port

Integer

 

protocol

GraphicsType

 

tls_port

Integer

 
Expand
表6.126 リンクの概要
Nameタイプ概要

instance_type

InstanceType

 

template

Template

 

vm

Vm

 

6.94. GraphicsType enum
リンクのコピー

Expand
表6.127 値の概要
Name概要

spice

 

vnc

 

6.95. Group 構造体
リンクのコピー

このタイプは、ディレクトリーサービス内のすべてのグループを表します。

Expand
表6.128 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

domain_entry_id

String

含まれるディレクトリーサービスドメイン ID。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

namespace

String

グループが存在する名前空間。

Expand
表6.129 リンクの概要
Nameタイプ概要

domain

Domain

このグループを含むドメインへのリンク。

permissions

Permission[]

このグループにアタッチされたパーミッションのパーミッションサブコレクションへのリンク。

roles

Role[]

このグループにアタッチされたロールのロールサブコレクションへのリンク。

tags

Tag[]

このグループにアタッチされたタグのタグサブコレクションへのリンク。

6.96. GuestOperatingSystem struct
リンクのコピー

Expand
表6.130 属性の概要
Nameタイプ概要

architecture

String

 

codename

String

 

distribution

String

 

family

String

 

kernel

カーネル

 

version

バージョン

 

6.97. HardwareInformation 構造体
リンクのコピー

Expand
表6.131 属性の概要
Nameタイプ概要

family

String

 

manufacturer

String

 

product_name

String

 

serial_number

String

 

supported_rng_sources

RngSource[]

 

uuid

String

 

version

String

 

6.98. HighAvailability 構造体
リンクのコピー

Expand
表6.132 属性の概要
Nameタイプ概要

enabled

ブール値

 

priority

Integer

 

6.99. Hook 構造体
リンクのコピー

Expand
表6.133 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

event_name

String

 

id

String

一意の ID

md5

String

 

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.134 リンクの概要
Nameタイプ概要

host

ホスト

 

6.100. HookContentType enum
リンクのコピー

フックスクリプトのコンテンツタイプを表します。

Expand
表6.135 値の概要
Name概要

binary

フックのバイナリーコンテンツタイプ。

text

フックのテキストコンテンツタイプ。

6.101. HookStage enum
リンクのコピー

Expand
表6.136 値の概要
Name概要

post

 

pre

 

6.102. HookStatus enum
リンクのコピー

タイプはフックのステータスを表します。

Expand
表6.137 値の概要
Name概要

disabled

フックが無効になっています。

enabled

フックが有効になっています。

missing

フックがありません。

6.103. Host 構造体
リンクのコピー

ホストを表すタイプ。

Expand
表6.138 属性の概要
Nameタイプ概要

address

String

ホストアドレス (FQDN/IP)。

auto_numa_status

AutoNumaStatus

ホストの自動 Non-Uniform Memory Access (NUMA) ステータス。

certificate

証明書

ホスト証明書。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

cpu

Cpu

このホストの CPU タイプ。

description

String

プレーンテキストでの人間が判読できる説明。

device_passthrough

HostDevicePassthrough

このホストでホストデバイスのパススルーが有効であるかどうかを指定します。

display

表示

オプションで、このホストの表示アドレスを明示的に指定します。

external_status

ExternalStatus

ホストの外部ステータス。

hardware_information

HardwareInformation

ホストハードウェア情報。

hosted_engine

HostedEngine

このホストのホスト型エンジンのステータス。

id

String

一意の ID

iscsi

IscsiDetails

ホスト iSCSI の詳細。

kdump_status

KdumpStatus

ホストの KDUMP ステータス。

ksm

Ksm

Kernel SamePage Merging(KSM) は、複数の同一ページから 1 つのページ参照にメモリーページへの参照を削減します。

libvirt_version

バージョン

ホストの libvirt バージョン。

max_scheduling_memory

Integer

このホストの最大スケジューリングメモリー (バイト単位)。

memory

Integer

このホストの物理メモリーの量 (バイト単位)。

name

String

人間が判読できるプレーンテキストでの名前。

numa_supported

ブール値

このホストで Non-Uniform Memory Access (NUMA) をサポートしているかどうかを指定します。

os

OperatingSystem

このホストのオペレーティングシステム。

override_iptables

ブール値

ファイアウォール定義をオーバーライドする必要があるかどうかを指定します。

port

Integer

ホストポート。

power_management

PowerManagement

ホストの電源管理の定義。

protocol

HostProtocol

エンジンがホストとの通信に使用するプロトコル。

root_password

String

新しいホストを作成するときに、パスワード認証方法を選択した場合は root パスワードが必要ですが、これはその後の表現には含まれません。

se_linux

SeLinux

ホストの SElinux ステータス。

spm

Spm

ホスト Storage Pool Manager (SPM) のステータスと定義。

ssh

Ssh

SSH 定義。

status

HostStatus

ホストのステータス。

status_detail

String

ホストステータスの詳細。

summary

VmSummary

仮想マシンの概要 - アクティブ数、移行数、および合計数。

transparent_huge_pages

TransparentHugePages

透過的な Huge Page のサポートにより、メモリーページのサイズが標準の 4 KiB の制限を超えて拡張されます。

type

HostType

ホストにオペレーティングシステムのフルインストールが含まれているか、仮想マシンをホストすることのみを目的とした縮小版が含まれているかを示します。

update_available

ブール値

このホストに oVirt 関連の更新があるかどうかを指定します。

version

バージョン

VDSM のバージョン。

6.103.1. external_status
リンクのコピー

ホストの外部ステータス。これは、サードパーティーのソフトウェアが、問題が発生した場合にホスト外部のステータスを変更するために使用することができます。サードパーティーのソフトウェアがこのステータスをチェックしてそれに応じて行動しない限り、これはホストのライフサイクルに影響を与えません。

6.103.2. kdump_status
リンクのコピー

ホストの KDUMP ステータス。KDUMP は、ホストカーネルがクラッシュし、メモリーダンプが実行されているときに発生します。

6.103.3. ksm
リンクのコピー

Kernel SamePage Merging(KSM) は、複数の同一ページから 1 つのページ参照にメモリーページへの参照を削減します。これは、メモリー密度の最適化に役立ちます。

たとえば、ホスト 123 に対して KSM を有効にするには、以下のようなリクエストを送信します。 

PUT /ovirt-engine/api/hosts/123
Copy to Clipboard Toggle word wrap

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

<host>
  <ksm>
    <enabled>true</enabled>
  </ksm>
</host>
Copy to Clipboard Toggle word wrap

6.103.4. libvirt_version
リンクのコピー

ホストの libvirt バージョン。libvirt の詳細は、libvirt を参照してください。

6.103.5. override_iptables
リンクのコピー

ファイアウォール定義をオーバーライドする必要があるかどうかを指定します。これは、ホストがインストールまたは再インストールされた場合にのみ適用されます。

6.103.6. se_linux
リンクのコピー

ホストの SElinux ステータス。Security-Enhanced Linux (SELinux) は、アクセス制御セキュリティーポリシーをサポートするためのメカニズムを提供する Linux カーネルのコンポーネントです。

6.103.7. spm
リンクのコピー

ホスト Storage Pool Manager (SPM) のステータスと定義。これを使用して、このホストの SPM 優先度を設定し、これが現在の SPM であるかどうかを確認します。

6.103.8. status_detail
リンクのコピー

ホストステータスの詳細。Gluster ホストに関連します。

6.103.9. transparent_huge_pages
リンクのコピー

透過的な Huge Page のサポートにより、メモリーページのサイズが標準の 4 KiB の制限を超えて拡張されます。これにより、メモリー消費が削減され、ホストのパフォーマンスが向上します。

たとえば、ホスト 123 の透過的な Huge Page のサポートを有効にするには、次のようなリクエストを送信します。 

PUT /ovirt-engine/api/hosts/123
Copy to Clipboard Toggle word wrap

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

<host>
  <transparent_hugepages>
    <enabled>true</enabled>
  </transparent_hugepages>
</host>
Copy to Clipboard Toggle word wrap

6.103.10. version
リンクのコピー

VDSM のバージョン。

以下に例を示します。 

GET /ovirt-engine/api/hosts/123
Copy to Clipboard Toggle word wrap

この GET リクエストは、以下の出力を返します。 

<host>
  ...
  <version>
    <build>999</build>
    <full_version>vdsm-4.18.999-419.gitcf06367.el7</full_version>
    <major>4</major>
    <minor>18</minor>
    <revision>0</revision>
  </version>
  ...
</host>
Copy to Clipboard Toggle word wrap
Expand
表6.139 リンクの概要
Nameタイプ概要

affinity_labels

AffinityLabel[]

 

agents

Agent[]

 

cluster

Cluster

 

devices

Device[]

 

external_host_provider

ExternalHostProvider

 

hooks

Hook[]

 

katello_errata

KatelloErratum[]

ホストに割り当てられているすべての Katello エラータを一覧表示します。

network_attachments

NetworkAttachment[]

 

nics

Nic[]

 

numa_nodes

NumaNode[]

 

permissions

Permission[]

 

statistics

Statistic[]

各ホストリソースは、ホスト固有の統計の統計サブコレクションを公開します。

storage_connection_extensions

StorageConnectionExtension[]

 

storages

HostStorage[]

 

tags

Tag[]

 

unmanaged_networks

UnmanagedNetwork[]

 

6.104. HostDevice 構造体
リンクのコピー

Expand
表6.140 属性の概要
Nameタイプ概要

capability

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

iommu_group

Integer

 

name

String

人間が判読できるプレーンテキストでの名前。

physical_function

HostDevice

 

placeholder

ブール値

 

product

製品

 

vendor

Vendor

 

virtual_functions

Integer

 
Expand
表6.141 リンクの概要
Nameタイプ概要

host

ホスト

 

parent_device

HostDevice

 

vm

Vm

 

6.105. HostDevicePassthrough 構造体
リンクのコピー

Expand
表6.142 属性の概要
Nameタイプ概要

enabled

ブール値

 

6.106. HostNic struct
リンクのコピー

ホスト NIC を表します。

たとえば、ホスト NIC の XML 表現は次のようになります。 

<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456">
  <name>eth0</name>
  <boot_protocol>static</boot_protocol>
  <bridged>true</bridged>
  <custom_configuration>true</custom_configuration>
  <ip>
    <address>192.168.122.39</address>
    <gateway>192.168.122.1</gateway>
    <netmask>255.255.255.0</netmask>
    <version>v4</version>
  </ip>
  <ipv6>
    <gateway>::</gateway>
    <version>v6</version>
  </ipv6>
  <ipv6_boot_protocol>none</ipv6_boot_protocol>
  <mac>
    <address>52:54:00:0c:79:1d</address>
  </mac>
  <mtu>1500</mtu>
  <status>up</status>
</host_nic>
Copy to Clipboard Toggle word wrap

ボンディングされたインターフェイスは、bonding 属性と slaves 属性を含む HostNic オブジェクトとして表されます。

たとえば、ボンディングされたホスト NIC の XML 表現は次のようになります。 

<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456">
  <name>bond0</name>
  <mac address="00:00:00:00:00:00"/>
  <ip>
    <address>192.168.122.39</address>
    <gateway>192.168.122.1</gateway>
    <netmask>255.255.255.0</netmask>
    <version>v4</version>
  </ip>
  <boot_protocol>dhcp</boot_protocol>
  <bonding>
    <options>
      <option>
        <name>mode</name>
        <value>4</value>
        <type>Dynamic link aggregation (802.3ad)</type>
      </option>
      <option>
        <name>miimon</name>
        <value>100</value>
      </option>
    </options>
    <slaves>
      <host_nic id="123"/>
      <host_nic id="456"/>
    </slaves>
  </bonding>
  <mtu>1500</mtu>
  <bridged>true</bridged>
  <custom_configuration>false</custom_configuration>
</host_nic>
Copy to Clipboard Toggle word wrap
Expand
表6.143 属性の概要
Nameタイプ概要

ad_aggregator_id

Integer

モード 4 のボンドの場合、ボンドまたはボンドスレーブの ad_aggregator_id プロパティー。

base_interface

String

NIC のベースインターフェイス。

bonding

ボンディング

NIC のボンディングパラメーター。

boot_protocol

BootProtocol

NIC の IPv4 ブートプロトコル設定。

bridged

ブール値

ブリッジネットワークのステータスを定義します。

check_connectivity

ブール値

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

custom_configuration

ブール値

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

ip

Ip

NIC の IPv4 アドレス。

ipv6

Ip

NIC の IPv6 アドレス。

ipv6_boot_protocol

BootProtocol

NIC の IPv6 ブートプロトコル設定。

mac

Mac

NIC の MAC アドレス。

mtu

Integer

インターフェイスの最大伝送単位。

name

String

人間が判読できるプレーンテキストでの名前。

network_labels

NetworkLabel[]

この NIC に適用されるラベル。

override_configuration

ブール値

 

properties

Property[]

 

speed

Integer

 

statistics

Statistic[]

NIC の統計へのリンク。

status

NicStatus

 

virtual_functions_configuration

HostNicVirtualFunctionsConfiguration

SR-IOV Physical Function NIC の場合は、仮想機能の設定を説明します。

vlan

Vlan

 

6.106.1. ad_aggregator_id
リンクのコピー

モード 4 のボンドの場合、ボンドまたはボンドスレーブの ad_aggregator_id プロパティー。ボンディングモード 4 は 802.3ad 標準で、動的リンクアグリゲーション - Wikipedia Presentation とも呼ばれます。これは、ボンディングの一部であるモード 4 または NIC （ネットワークインターフェイスカード）のボンディングにのみ有効です。他のモードのボンディングや、モード 4 のボンディングの一部ではない NIC には存在しません。ad_aggregator_id プロパティーは、どのボンディングスレーブがアクティブであるかを示します。アクティブなスレーブの ad_aggregator_id の値は、ボンドの ad_aggregator_id プロパティーの値と同じです。このパラメーターは読み取り専用です。設定してもボンディング/NIC には影響しません。これは、ボンディングの場合は /sys/class/net/bondX/bonding/ad_aggregator ファイル、NIC の場合は /sys/class/net/ensX/bonding_slave/ad_aggregator_id ファイルから取得されます。

6.106.2. bridged
リンクのコピー

ブリッジネットワークのステータスを定義します。ブリッジネットワークの場合は true に設定し、ブリッジレスネットワークの場合は false に設定します。

6.106.3. statistics
リンクのコピー

NIC の統計へのリンク。

HostNic 統計値のデータタイプ :

  • data.current.rx - 受信したデータの 1 秒あたりのバイト数。
  • data.current.tx - 送信されたデータ速度 (バイト毎秒)。
  • data.total.rx - 受信したデータの合計。
  • data.total.tx - 送信されたデータの合計。
  • errors.total.rx - データの受信によるエラーの合計。
  • errors.total.tx - データの送信によるエラーの合計。
Expand
表6.144 リンクの概要
Nameタイプ概要

host

ホスト

 

network

ネットワーク

インターフェイスが接続するネットワークへの参照。

physical_function

HostNic

SR-IOV Virtual Function NIC については、物理機能 NIC への参照。

qos

Qos

インターフェイスの quality-of-service 設定へのリンク。

6.107. HostNicVirtualFunctionsConfiguration struct
リンクのコピー

SR-IOV 対応の物理機能 NIC の仮想機能設定について説明します。

Expand
表6.145 属性の概要
Nameタイプ概要

all_networks_allowed

ブール値

関連する Virtual Function でのみすべてのネットワークを定義できるようにするか、または指定したネットワークのみを定義します。

max_number_of_virtual_functions

Integer

NIC がサポートする仮想機能の最大数。

number_of_virtual_functions

Integer

現在定義されている仮想機能の数。

6.107.1. max_number_of_virtual_functions
リンクのコピー

NIC がサポートする仮想機能の最大数。読み取り専用プロパティー。

6.107.2. number_of_virtual_functions
リンクのコピー

現在定義されている仮想機能の数。0 から maxNumberOfVirtualFunctions までのユーザー定義値。

6.108. HostProtocol enum
リンクのコピー

エンジンがホストと通信するために使用するプロトコル。

Expand
表6.146 値の概要
Name概要

stomp

STOMP 上の JSON-RPC プロトコル。

xml

XML-RPC プロトコル。

6.109. HostStatus enum
リンクのコピー

ホストステータスを表すタイプ。

Expand
表6.147 値の概要
Name概要

connecting

エンジンは特定のしきい値の場合はホストと通信できないので、現時点ではフェンシングを通過する前に接続を試みています。

down

ホストがダウンしています。

error

ホストはエラーステータスにあります。

initializing

ホストは初期化中です。

install_failed

ホストのインストールに失敗しました。

installing

ホストがインストールされています。

installing_os

これで、ホストオペレーティングシステムがインストールされます。

kdumping

ホストカーネルがクラッシュし、メモリーダンプが実行されています。

maintenance

ホストのステータスは maintenance です。

non_operational

ホストは動作しません。

non_responsive

ホストは応答しません。

pending_approval

ホストは管理者の承認を待っています。

preparing_for_maintenance

ホストはメンテナーンスの準備をしています。

reboot

ホストは再起動されています。

unassigned

ホストはアクティブ化プロセス中です。

up

ホストが稼働しています。

6.109.1. error
リンクのコピー

ホストはエラーステータスにあります。これは、仮想マシンを何度か実行しようとして失敗した場合に発生します。

6.109.2. initializing
リンクのコピー

ホストは初期化中です。これは、ホストを 'up' ステータスに移行する前の中間のステップです。

6.109.3. install_failed
リンクのコピー

ホストのインストールに失敗しました。このような場合は、イベントログを参照して、インストールに失敗した原因を把握し、再インストールを実行してください。

6.109.4. installing_os
リンクのコピー

これで、ホストオペレーティングシステムがインストールされます。このステータスは、Satellite/Foreman プロバイダーを使用し、ベアメタルプロビジョニング (検出されたホストプロビジョニング) を発行する場合に関連します。

6.109.5. maintenance
リンクのコピー

ホストのステータスは maintenance です。ホストがメンテナーンス中の場合、仮想マシンを実行できません。

6.109.6. non_operational
リンクのコピー

ホストは動作しません。これは、ストレージとの接続がない、必須ネットワークがサポートされていない、クラスターレベルがサポートされていないなど、さまざまな理由で発生する可能性があります。

6.109.7. non_responsive
リンクのコピー

ホストは応答しません。これは、エンジンがホストと通信できないことを意味します。

6.109.8. pending_approval
リンクのコピー

ホストは管理者の承認を待っています。これは、ヴィンテージの ovirt-node / RHV-H にのみ関連します。

6.109.9. preparing_for_maintenance
リンクのコピー

ホストはメンテナーンスの準備をしています。この間、エンジンはすべての仮想マシンをこのホストから他のホストにライブマイグレーションします。すべての移行が完了すると、ホストは 'maintenance' ステータスに移行します。

6.110. HostStorage 構造体
リンクのコピー

Expand
表6.148 属性の概要
Nameタイプ概要

address

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

logical_units

LogicalUnit[]

 

mount_options

String

 

name

String

人間が判読できるプレーンテキストでの名前。

nfs_retrans

Integer

さらなるリカバリーアクションを試みる前に、リクエストを再試行する回数。

nfs_timeo

Integer

NFS 要求を再試行する前に応答を待つ時間 (10 分の 1 秒単位)。

nfs_version

NfsVersion

 

override_luns

ブール値

 

password

String

 

path

String

 

port

Integer

 

portal

String

 

target

String

 

type

StorageType

 

username

String

 

vfs_type

String

 

volume_group

VolumeGroup

 

6.110.1. nfs_retrans
リンクのコピー

さらなるリカバリーアクションを試みる前に、リクエストを再試行する回数。値は 0 から 65535 の範囲に指定する必要があります。詳細は、nfs の man ページの retrans マウントオプションの説明を参照してください。

6.110.2. nfs_timeo
リンクのコピー

NFS 要求を再試行する前に応答を待つ時間 (10 分の 1 秒単位)。値は 0 から 65535 の範囲に指定する必要があります。詳細は、nfs の man ページの timeo マウントオプションの説明を参照してください。

Expand
表6.149 リンクの概要
Nameタイプ概要

host

ホスト

 

6.111. HostType enum
リンクのコピー

この列挙型は、ホストが使用するオペレーティングシステムのタイプに使用されます。

Expand
表6.150 値の概要
Name概要

ovirt_node

ホストは NGN (Next Generation Node)です。これは、RHEL、CentOS、または Fedora インストールなどの RHEV_H の新しい実装です。

rhel

ホストには、完全な RHEL、CentOS、または Fedora インストールが含まれています。

rhev_h

ホストには、仮想マシンをホストするためだけに使用される RHEL、CentOS、または Fedora の小規模なスケーリングバージョンが含まれています。

6.111.1. ovirt_node
リンクのコピー

ホストは NGN (Next Generation Node)です。これは、RHEL、CentOS、または Fedora インストールなどの RHEV_H の新しい実装です。NGN とレガシー RHEV-H の主な違いは、NGN には書き込み可能なファイルシステムがあり、レガシー RHEV-H のエンジンによって RPM をプッシュするのではなく、インストールを処理することです。

6.112. HostedEngine 構造体
リンクのコピー

Expand
表6.151 属性の概要
Nameタイプ概要

active

ブール値

 

configured

ブール値

 

global_maintenance

ブール値

 

local_maintenance

ブール値

 

score

Integer

 

6.113. Icon 構造体
リンクのコピー

仮想マシンまたはテンプレートのアイコン。

Expand
表6.152 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

data

String

アイコンファイルの Base64 エンコードコンテンツ。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

media_type

String

アイコンファイルのフォーマット。

name

String

人間が判読できるプレーンテキストでの名前。

6.113.1. media_type
リンクのコピー

アイコンファイルのフォーマット。

以下のいずれかになります。

  • image/jpeg
  • image/png
  • image/gif

6.114. Identified 構造体
リンクのコピー

このインターフェイスは、識別子を持つオブジェクトを表すすべてのタイプの基本モデルです。

Expand
表6.153 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

6.115. Image 構造体
リンクのコピー

Expand
表6.154 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.155 リンクの概要
Nameタイプ概要

storage_domain

StorageDomain

 

6.116. ImageTransfer 構造体
リンクのコピー

このタイプには、実行中のイメージ転送に関する情報が含まれます。

Expand
表6.156 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

phase

ImageTransferPhase

進行中のイメージ転送の現在のフェーズ。

proxy_url

String

ユーザーが入力または出力するプロキシーサーバーの URL。

signed_ticket

String

入力または出力するプロキシーサーバーの HTTPS リクエストの 認証 ヘッダーとしてアタッチする必要がある署名付きチケット( proxy_url 属性を参照)。

6.116.1. phase
リンクのコピー

進行中のイメージ転送の現在のフェーズ。各転送には、管理されたセッションが必要です。このセッションは、ユーザーがイメージを入力または出力するために開かれている必要があります。詳細は、イメージ転送 を参照してください。

6.116.2. proxy_url
リンクのコピー

ユーザーが入力または出力するプロキシーサーバーの URL。この属性は、イメージ転送エンティティーが 転送 フェーズにある場合にのみ利用できます。詳細は、phase を参照してください。

Expand
表6.157 リンクの概要
Nameタイプ概要

host

ホスト

入力または出力の対象となるイメージへの書き込みに使用されるホスト。

image

Image

I/O の対象となるイメージ。

6.117. ImageTransferPhase enum
リンクのコピー

イメージ転送 エンティティーのフェーズのリスト。これらの値はそれぞれ、転送フローの特定のポイントを定義します。

詳細は、イメージ転送 を参照してください。

Expand
表6.158 値の概要
Name概要

cancelled

このフェーズは、ユーザーが転送をキャンセルした結果として設定されます。

finalizing_failure

このフェーズは、管理ポータルでのみ設定でき、転送中にエラーが発生し、失敗してファイナライズされていることを示します。

finalizing_success

このフェーズは、ユーザーが finalize を呼び出したときに設定されます。

finished_failure

対象のイメージが検証に失敗し、使用できないことを示します。

finished_success

転送セッションが正常に終了し、対象のイメージが検証されて使用できる状態になったことを示します。

initializing

イメージ転送の初期段階。

paused_system

このフェーズは、セッションがタイムアウトしたか、この転送で他のエラーが発生した場合（例：選択したホストで ovirt-imageio-daemon が実行されていない）を意味します。

paused_user

このフェーズは、ユーザーが pause を使用して一時停止を呼び出した結果です。

resuming

クライアントが resume を呼び出して転送が再開されたフェーズ。

transferring

転送セッションが開始され、クライアントが任意のツールを使用して目的のイメージを入力または出力できるフェーズ。

unknown

未知のフェーズ。

6.117.1. cancelled
リンクのコピー

このフェーズは、ユーザーが転送をキャンセルした結果として設定されます。キャンセルは、管理ポータルでのみ実行できます。

6.117.2. finalizing_success
リンクのコピー

このフェーズは、ユーザーが finalize を呼び出したときに設定されます。転送セッションを終了し、対象のイメージの使用を終了するには、finalize の呼び出しが不可欠です。ファイナライズ後、フェーズは finished_success または finished_failure に変更されます。

詳細は、イメージ転送 を参照してください。

6.117.3. finished_failure
リンクのコピー

対象のイメージが検証に失敗し、使用できないことを示します。このフェーズに達すると、イメージ転送エンティティーが削除され、対象のイメージが illegal に設定されます。

6.117.4. finished_success
リンクのコピー

転送セッションが正常に終了し、対象のイメージが検証されて使用できる状態になったことを示します。このフェーズに到達すると、イメージ転送エンティティーは削除されます。

6.117.5. initializing
リンクのコピー

イメージ転送の初期段階。転送セッションの確立中に設定されます。セッションが確立されると、フェーズが transferring に変更されます

6.117.6. paused_system
リンクのコピー

このフェーズは、セッションがタイムアウトしたか、この転送で他のエラーが発生した場合（例：選択したホストで ovirt-imageio-daemon が実行されていない）を意味します。セッションを再開するには、クライアントは resume を呼び出す必要があります。再開後、フェーズは resuming に切り替わります。

6.117.7. resuming
リンクのコピー

クライアントが resume を呼び出して転送が再開されたフェーズ。再開すると新しいセッションが開始され、呼び出した後、フェーズは transferring、失敗した場合は paused_system に変更されます。

6.117.8. unknown
リンクのコピー

未知のフェーズ。これは、予期しないエラーが発生した場合にのみ設定されます。

6.118. InheritableBoolean enum
リンクのコピー

設定するか、上位レベルから継承できるブール値を表す enum。継承順は仮想マシン → クラスター → engine-config です。

Expand
表6.159 値の概要
Name概要

false

このレベルで値を false に設定します。

inherit

上位レベルから値を継承します。

true

このレベルで値を true に設定します。

6.119. Initialization 構造体
リンクのコピー

Expand
表6.160 属性の概要
Nameタイプ概要

active_directory_ou

String

 

authorized_ssh_keys

String

 

cloud_init

CloudInit

 

configuration

設定

 

custom_script

String

 

dns_search

String

 

dns_servers

String

 

domain

String

 

host_name

String

 

input_locale

String

 

nic_configurations

NicConfiguration[]

 

org_name

String

 

regenerate_ids

ブール値

 

regenerate_ssh_keys

ブール値

 

root_password

String

 

system_locale

String

 

timezone

String

 

ui_language

String

 

user_locale

String

 

user_name

String

 

windows_license_key

String

 

6.120. InstanceType 構造体
リンクのコピー

仮想マシンのハードウェア設定について説明します。

たとえば、medium インスタンスタイプには、1 つの仮想 CPU と 4GiB のメモリーが含まれています。これは最上位のエンティティーです (たとえば、データセンターやクラスターにバインドされていません)。インスタンスタイプに使用され、仮想マシンおよびテンプレートタイプに共通する属性は次のとおりです。

  • console
  • cpu
  • custom_cpu_model
  • custom_emulated_machine
  • display
  • high_availability
  • io
  • memory
  • memory_policy
  • migration
  • migration_downtime
  • os
  • rng_device
  • soundcard_enabled
  • usb
  • virtio_scsi

インスタンスタイプとテンプレートの両方から仮想マシンを作成する場合、仮想マシンはインスタンスタイプからハードウェア設定を継承します。

注記

ほとんどのテンプレート属性はインスタンスタイプでは使用されませんが、インスタンスタイプはその属性をテンプレートエンティティーから継承します。

Expand
表6.161 属性の概要
Nameタイプ概要

bios

Bios

仮想マシンの BIOS 設定への参照。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

console

コンソール

この仮想マシン用に設定されたコンソール。

cpu

Cpu

仮想マシン CPU の設定。

cpu_shares

Integer

 

creation_time

日付

仮想マシンの作成日。

custom_compatibility_version

バージョン

仮想マシンのカスタム互換性バージョン。

custom_cpu_model

String

 

custom_emulated_machine

String

 

custom_properties

CustomProperty[]

さまざまなフックを設定するために VDSM に送信されるプロパティー。

delete_protected

ブール値

true の場合、仮想マシンは削除できません。

description

String

プレーンテキストでの人間が判読できる説明。

display

表示

仮想マシンの表示設定。

domain

Domain

この仮想マシン用に設定されたドメイン。

high_availability

高可用性

仮想マシンの高可用性設定。

id

String

一意の ID

initialization

初期化

仮想マシンの初期化設定への参照。

io

Io

IO スレッドのパフォーマンスチューニング用。

large_icon

アイコン

仮想マシンの大きなアイコン。

memory

Integer

仮想マシンのメモリー (バイト単位)。

memory_policy

MemoryPolicy

仮想マシンのメモリー管理設定への参照。

migration

MigrationOptions

実行中の仮想マシンの別のホストへの移行設定への参照。

migration_downtime

Integer

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

name

String

人間が判読できるプレーンテキストでの名前。

origin

String

この仮想マシンのオリジン。

os

OperatingSystem

仮想マシンにインストールされているオペレーティングシステムのタイプ。

rng_device

RngDevice

この仮想マシンの乱数ジェネレーターデバイスの設定。

serial_number

SerialNumber

クラスター内の仮想マシンのシリアル番号。

small_icon

アイコン

仮想マシンの小さなアイコン。

soundcard_enabled

ブール値

true の場合、サウンドカードが仮想マシンに追加されます。

sso

Sso

この仮想マシンが設定されているシングルサインオン設定への参照。

start_paused

ブール値

true の場合、仮想マシンは起動後、最初は 'paused' 状態になります。

stateless

ブール値

true の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。

status

TemplateStatus

テンプレートのステータス

time_zone

TimeZone

oVirt によって設定された仮想マシンのタイムゾーン。

tunnel_migration

ブール値

true の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。

type

VmType

仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。

usb

Usb

この仮想マシンの USB デバイスの設定 (カウント、タイプ)。

version

TemplateVersion

これが別のテンプレートのベースバージョンかサブバージョンであるかを示します。

virtio_scsi

VirtioScsi

VirtIO SCSI 設定への参照。

vm

Vm

このテンプレートに関連付けられている仮想マシンの設定。

6.120.1. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>
Copy to Clipboard Toggle word wrap

6.120.2. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

仮想マシンを独自の互換性バージョンにカスタマイズできるようにします。custom_compatibility_version が設定されている場合、この特定の仮想マシンのクラスター互換性バージョンをオーバーライドします。

仮想マシンの互換バージョンは、仮想マシンが格納されているデータセンターによって制限され、仮想マシンが実行される予定のホストの機能に対してチェックされます。

6.120.3. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

6.120.4. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.120.5. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>
Copy to Clipboard Toggle word wrap
注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 230 バイト = 1073741824 バイト。

注記

メモリーホットプラグは、Red Hat Virtualization 3.6 以降でサポートされています。上記の例では、仮想マシンの実行中にメモリーを増やすことができます。

6.120.6. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

6.120.7. origin
リンクのコピー

この仮想マシンのオリジン。

値:

  • ovirt
  • rhev
  • vmware
  • xen
  • external
  • hosted_engine
  • managed_hosted_engine
  • kvm
  • physical_machine
  • hyperv

6.120.8. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.120.9. sso
リンクのコピー

この仮想マシンが設定されているシングルサインオン設定への参照。コンソールを開くと、ユーザーは仮想マシンのオペレーティングシステムに自動的にサインインできます。

Expand
表6.162 リンクの概要
Nameタイプ概要

cdroms

Cdrom[]

テンプレートにアタッチされた CD-ROM デバイスへの参照。

cluster

Cluster

仮想マシンが属するクラスターへの参照。

cpu_profile

CpuProfile

この仮想マシンによって使用される CPU プロファイルへの参照。

disk_attachments

DiskAttachment[]

テンプレートに割り当てられたディスクへの参照。

graphics_consoles

GraphicsConsole[]

テンプレートに接続されたグラフィックコンソールへの参照。

nics

Nic[]

テンプレートにアタッチされたネットワークインターフェイスへの参照。

permissions

Permission[]

テンプレートに割り当てられたユーザーパーミッションへの参照。

quota

クォータ

この仮想マシンに設定されたクォータ設定への参照。

storage_domain

StorageDomain

仮想マシンが属するストレージドメインへの参照。

tags

Tag[]

テンプレートにアタッチされたタグへの参照。

watchdogs

Watchdog[]

テンプレートにアタッチされたウォッチドッグデバイスへの参照。

6.121. Io 構造体
リンクのコピー

Expand
表6.163 属性の概要
Nameタイプ概要

threads

Integer

 

6.122. Ip 構造体
リンクのコピー

ネットワークインターフェイスの IP 設定を表します。

Expand
表6.164 属性の概要
Nameタイプ概要

address

String

IP アドレスのテキスト表現。

gateway

String

デフォルトゲートウェイのアドレス。

netmask

String

ネットワークマスク。

version

IpVersion

IP プロトコルのバージョン。

6.122.1. address
リンクのコピー

IP アドレスのテキスト表現。

たとえば、IPv4 アドレスは以下のように表現されます。 

<ip>
  <address>192.168.0.1</address>
  ...
</ip>
Copy to Clipboard Toggle word wrap

IPv6 アドレスは次のように表されます。 

<ip>
  <address>2620:52:0:20f0:4216:7eff:feaa:1b50</address>
  ...
</ip>
Copy to Clipboard Toggle word wrap

6.122.2. version
リンクのコピー

IP プロトコルのバージョン。

注記

Manager のバージョン 4.1 から、この属性はオプションになり、値が指定されていない場合は、address 属性の値から推測されます。

6.123. IpAddressAssignment struct
リンクのコピー

Expand
表6.165 属性の概要
Nameタイプ概要

assignment_method

BootProtocol

 

ip

Ip

 

6.124. IpVersion enum
リンクのコピー

IP プロトコルバージョンの値を定義します。

Expand
表6.166 値の概要
Name概要

v4

IPv4。

v6

IPv6。

6.125. IscsiBond struct
リンクのコピー

Expand
表6.167 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.168 リンクの概要
Nameタイプ概要

data_center

DataCenter

 

networks

Network[]

 

storage_connections

StorageConnection[]

 

6.126. IscsiDetails struct
リンクのコピー

Expand
表6.169 属性の概要
Nameタイプ概要

address

String

 

disk_id

String

 

initiator

String

 

lun_mapping

Integer

 

password

String

 

paths

Integer

 

port

Integer

 

portal

String

 

product_id

String

 

serial

String

 

size

Integer

 

status

String

 

storage_domain_id

String

 

target

String

 

username

String

 

vendor_id

String

 

volume_group_id

String

 

6.127. Job 構造体
リンクのコピー

システム内のフローの実行を監視するジョブを表します。ジョブには、階層構造の複数のステップを含めることができます。ステップは並行して処理できますが、フローの実装によって異なります。

Expand
表6.170 属性の概要
Nameタイプ概要

auto_cleared

ブール値

システムによってジョブが完了した後、ジョブが自動的にクリアされるかどうかを示します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

end_time

日付

ジョブの終了時刻。

external

ブール値

ジョブが外部システムによって開始されたかどうかを示します。

id

String

一意の ID

last_updated

日付

ジョブの最終更新日。

name

String

人間が判読できるプレーンテキストでの名前。

start_time

日付

ジョブの開始時刻。

status

JobStatus

ジョブのステータス。

6.127.1. external
リンクのコピー

ジョブが外部システムによって開始されたかどうかを示します。外部ジョブは、ジョブの作成者によって外部で管理されます。

Expand
表6.171 リンクの概要
Nameタイプ概要

owner

User

ジョブの所有者であるユーザー。

steps

step[]

ジョブのステップ。

6.128. JobStatus enum
リンクのコピー

ステップのステータスを表します。

Expand
表6.172 値の概要
Name概要

aborted

中止されたジョブのステータス。

failed

失敗したジョブのステータス。

finished

終了したジョブのステータス。

started

開始されたジョブのステータス。

unknown

不明なジョブのステータス。

6.128.1. aborted
リンクのコピー

中止されたジョブのステータス。このステータスは、強制的に中止された外部ジョブに適用されます。

6.128.2. finished
リンクのコピー

終了したジョブのステータス。このステータスは、ジョブの実行が完了したことを示します。

6.128.3. started
リンクのコピー

開始されたジョブのステータス。このステータスは、現在実行中のジョブを表します。

6.128.4. unknown
リンクのコピー

不明なジョブのステータス。このステータスは、解決方法が不明なジョブ、つまり、システムが予期せず再起動される前に実行されたジョブを表します。

6.129. KatelloErratum struct
リンクのコピー

Katello erratum を表すタイプ。

Expand
表6.173 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

issued

日付

Katello エラータが発行された日付。

name

String

人間が判読できるプレーンテキストでの名前。

packages

Package[]

Katello エラータによって報告された問題を解決するパッケージのリスト。

severity

String

Katello エラータの重大度。

solution

String

Katello エラータで記述されている問題のソリューション。

summary

String

Katello エラータの要約。

title

String

Katello エラータのタイトル。

type

String

Katello エラータのタイプ。

6.129.1. severity
リンクのコピー

Katello エラータの重大度。

サポートされる重要度は、moderate、important、critical です。

6.129.2. type
リンクのコピー

Katello エラータのタイプ。

サポートされるタイプは、bugfix、enhancement、security です。

Expand
表6.174 リンクの概要
Nameタイプ概要

host

ホスト

Katello エラータが割り当てられているホストへの参照。

vm

Vm

Katello エラータが割り当てられている仮想マシンへの参照。

6.130. KdumpStatus enum
リンクのコピー

Expand
表6.175 値の概要
Name概要

disabled

 

enabled

 

unknown

 

6.131. Kernel 構造体
リンクのコピー

Expand
表6.176 属性の概要
Nameタイプ概要

version

バージョン

 

6.132. Ksm 構造体
リンクのコピー

Expand
表6.177 属性の概要
Nameタイプ概要

enabled

ブール値

 

merge_across_nodes

ブール値

 

6.133. LogSeverity enum
リンクのコピー

イベントの重大度を表す列挙型。

Expand
表6.178 値の概要
Name概要

alert

アラートの重大度。

error

エラーの重大度。

normal

通常の重大度。

warning

警告の重大度。

6.133.1. alert
リンクのコピー

アラートの重大度。すぐに対処する必要がある状態を指定するために使用されます。

6.133.2. error
リンクのコピー

エラーの重大度。調査が必要なエラーがあることを指定するために使用されます。

6.133.3. normal
リンクのコピー

通常の重大度。情報イベントに使用されます。

6.133.4. warning
リンクのコピー

警告の重大度。何かが間違っている可能性があることを警告するために使用されます。

6.134. LogicalUnit 構造体
リンクのコピー

Expand
表6.179 属性の概要
Nameタイプ概要

address

String

 

disk_id

String

 

id

String

 

lun_mapping

Integer

 

password

String

 

paths

Integer

 

port

Integer

 

portal

String

 

product_id

String

 

serial

String

 

size

Integer

 

status

LunStatus

 

storage_domain_id

String

 

target

String

 

username

String

 

vendor_id

String

 

volume_group_id

String

 

6.135. LunStatus enum
リンクのコピー

Expand
表6.180 値の概要
Name概要

free

 

unusable

 

used

 

6.136. Mac 構造体
リンクのコピー

Expand
表6.181 属性の概要
Nameタイプ概要

address

String

 

6.137. MacPool 構造体
リンクのコピー

MAC アドレスプールを表します。

MAC アドレスプールの XML 表現の例: 

<mac_pool href="/ovirt-engine/api/macpools/123" id="123">
  <name>Default</name>
  <description>Default MAC pool</description>
  <allow_duplicates>false</allow_duplicates>
  <default_pool>true</default_pool>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:E6</to>
    </range>
  </ranges>
</mac_pool>
Copy to Clipboard Toggle word wrap
Expand
表6.182 属性の概要
Nameタイプ概要

allow_duplicates

ブール値

プールで重複する MAC アドレスを許可するかどうかを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

default_pool

ブール値

これがデフォルトプールかどうかを定義します。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

ranges

Range[]

プールの MAC アドレスの範囲を定義します。

6.137.1. allow_duplicates
リンクのコピー

プールで重複する MAC アドレスを許可するかどうかを定義します。指定されていない場合、 false にデフォルト設定されます。

6.137.2. default_pool
リンクのコピー

これがデフォルトプールかどうかを定義します。指定されていない場合、 false にデフォルト設定されます。

6.137.3. ranges
リンクのコピー

プールの MAC アドレスの範囲を定義します。複数の範囲を定義できます。

6.138. MemoryOverCommit struct
リンクのコピー

Expand
表6.183 属性の概要
Nameタイプ概要

percent

Integer

 

6.139. MemoryPolicy 構造体
リンクのコピー

Expand
表6.184 属性の概要
Nameタイプ概要

ballooning

ブール値

 

guaranteed

Integer

 

over_commit

MemoryOverCommit

 

transparent_huge_pages

TransparentHugePages

 

6.140. MessageBrokerType enum
リンクのコピー

Expand
表6.185 値の概要
Name概要

qpid

 

rabbit_mq

 

6.141. Method 構造体
リンクのコピー

Expand
表6.186 属性の概要
Nameタイプ概要

id

SsoMethod

 

6.142. MigrateOnError enum
リンクのコピー

Expand
表6.187 値の概要
Name概要

do_not_migrate

 

migrate

 

migrate_highly_available

 

6.143. MigrationBandwidth 構造体
リンクのコピー

移行で使用される帯域幅を定義します。

Expand
表6.188 属性の概要
Nameタイプ概要

assignment_method

MigrationBandwidthAssignmentMethod

帯域幅を割り当てるのに使用するメソッド。

custom_value

Integer

Mbps 単位のカスタム帯域幅。

6.143.1. custom_value
リンクのコピー

Mbps 単位のカスタム帯域幅。assignmentMethod 属性が custom の場合にのみ適用されます。

6.144. MigrationBandwidthAssignmentMethod enum
リンクのコピー

移行帯域幅の割り当て方法を定義します。

Expand
表6.189 値の概要
Name概要

auto

QoS が定義されている場合には、QoS から帯域幅を取得します。

custom

カスタム定義の帯域幅 (Mbit/s)。

hypervisor_default

ハイパーバイザーで設定された値を取得します。

6.144.1. auto
リンクのコピー

QoS が定義されている場合には、QoS から帯域幅を取得します。使用されていない場合は、使用されている検出されたリンク速度から取得されます。何も検出されない場合は、hypervisor_default 値に戻ります。

6.145. MigrationOptions 構造体
リンクのコピー

Expand
表6.190 属性の概要
Nameタイプ概要

auto_converge

InheritableBoolean

 

bandwidth

MigrationBandwidth

移行で使用できる帯域幅。

compressed

InheritableBoolean

 
Expand
表6.191 リンクの概要
Nameタイプ概要

policy

MigrationPolicy

engine-config を使用して定義された移行ポリシーへの参照。

6.146. MigrationPolicy 構造体
リンクのコピー

移行の処理方法を説明するポリシー（収束、許可される並列移行数）。

Expand
表6.192 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

6.147. Network 構造体
リンクのコピー

論理ネットワーク。

論理ネットワークの JSON 表現の例: 

{
  "network" : [ {
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "stp" : "false",
    "mtu" : "0",
    "usages" : {
      "usage" : [ "vm" ]
    },
    "name" : "ovirtmgmt",
    "description" : "Management Network",
    "href" : "/ovirt-engine/api/networks/456",
    "id" : "456",
    "link" : [ {
      "href" : "/ovirt-engine/api/networks/456/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/networks/456/vnicprofiles",
      "rel" : "vnicprofiles"
    }, {
      "href" : "/ovirt-engine/api/networks/456/labels",
      "rel" : "labels"
    } ]
  } ]
}
Copy to Clipboard Toggle word wrap

同じ論理ネットワークの XML 表現の例: 

<network href="/ovirt-engine/api/networks/456" id="456">
  <name>ovirtmgmt</name>
  <description>Management Network</description>
  <link href="/ovirt-engine/api/networks/456/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/456/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/456/labels" rel="labels"/>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
  <stp>false</stp>
  <mtu>0</mtu>
  <usages>
    <usage>vm</usage>
  </usages>
</network>
Copy to Clipboard Toggle word wrap
Expand
表6.193 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

display

ブール値

 

id

String

一意の ID

ip

Ip

 

mtu

Integer

ネットワークの最大伝送単位を指定します。

name

String

人間が判読できるプレーンテキストでの名前。

profile_required

ブール値

 

必須

ブール値

 

status

NetworkStatus

 

stp

ブール値

ネットワークに対してスパニングツリープロトコルを有効にするかどうかを指定します。

usages

NetworkUsage[]

ネットワークの使用要素のセットを定義します。

vlan

Vlan

 

6.147.1. usages
リンクのコピー

ネットワークの使用要素のセットを定義します。

たとえば、ユーザーは、vm および display の値を使用して、ネットワークが仮想マシントラフィックに使用され、ディスプレイトラフィックにも使用されるように指定できます。

Expand
表6.194 リンクの概要
Nameタイプ概要

cluster

Cluster

 

data_center

DataCenter

ネットワークがメンバーになっているデータセンターへの参照。

network_labels

NetworkLabel[]

ネットワークに割り当てられたラベルへの参照。

permissions

Permission[]

ネットワークのパーミッションへの参照。

qos

Qos

 

vnic_profiles

VnicProfile[]

ネットワークのプロファイルへの参照。

6.148. NetworkAttachment 構造体
リンクのコピー

ホストがネットワークに接続する方法について説明します。

ホスト上のネットワークアタッチメントの XML 表現: 

<network_attachment href="/ovirt-engine/api/hosts/123/nics/456/networkattachments/789" id="789">
  <network href="/ovirt-engine/api/networks/234" id="234"/>
  <host_nic href="/ovirt-engine/api/hosts/123/nics/123" id="123"/>
  <in_sync>true</in_sync>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>192.168.122.39</address>
        <gateway>192.168.122.1</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
  <reported_configurations>
    <reported_configuration>
      <name>mtu</name>
      <expected_value>1500</expected_value>
      <actual_value>1500</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    <reported_configuration>
      <name>bridged</name>
      <expected_value>true</expected_value>
      <actual_value>true</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>
Copy to Clipboard Toggle word wrap

ネットワークインターフェイスカードにネットワークを接続する場合は、id または 名前 のいずれかで network 要素が必要です。

たとえば、ネットワークをホストネットワークインターフェイスカードにアタッチするには、以下のようなリクエストを送信します。 

POST /ovirt-engine/api/hosts/123/nics/456/networkattachments
Copy to Clipboard Toggle word wrap

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

<networkattachment>
  <network id="234"/>
</networkattachment>
Copy to Clipboard Toggle word wrap

ホストに新しい作業を添付するには、次のようなリクエストを送信します。 

POST /ovirt-engine/api/hosts/123/networkattachments
Copy to Clipboard Toggle word wrap

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

<network_attachment>
  <network id="234"/>
  <host_nic id="456"/>
</network_attachment>
Copy to Clipboard Toggle word wrap

ip_address_assignments および properties 要素は、作成後に更新可能です。

たとえば、newtork 添付ファイルを更新するには、次のようなリクエストを送信します。 

PUT /ovirt-engine/api/hosts/123/nics/456/networkattachments/789
Copy to Clipboard Toggle word wrap

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

<network_attachment>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>7.1.1.1</address>
        <gateway>7.1.1.2</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
</network_attachment>
Copy to Clipboard Toggle word wrap

ネットワークインターフェイスカードからネットワークをデタッチするには、以下のようなリクエストを送信します。 

DELETE /ovirt-engine/api/hosts/123/nics/456/networkattachments/789
Copy to Clipboard Toggle word wrap
重要

ネットワークアタッチメント設定への変更は、明示的にコミットする必要があります。

ネットワークアタッチメントの properties サブコレクションの XML 表現。 

<network_attachment>
  <properties>
    <property>
      <name>bridge_opts</name>
      <value>
        forward_delay=1500 group_fwd_mask=0x0 multicast_snooping=1
      </value>
    </property>
  </properties>
  ...
</network_attachment>
Copy to Clipboard Toggle word wrap
Expand
表6.195 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

in_sync

ブール値

 

ip_address_assignments

IpAddressAssignment[]

ネットワークの IP 設定。

name

String

人間が判読できるプレーンテキストでの名前。

properties

Property[]

ネットワーク設定のカスタムプロパティーを定義します。

reported_configurations

ReportedConfiguration[]

設定プロパティーの読み取り専用リスト。

6.148.1. properties
リンクのコピー

ネットワーク設定のカスタムプロパティーを定義します。

ブリッジオプションのセット名は bridge_opts です。複数の項目を空白文字で区切ります。bridge_opts には、以下のキーが有効です。

Expand
Nameデフォルト値

forward_delay

1500

gc_timer

3765

group_addr

1:80:c2:0:0:0

group_fwd_mask

0x0

hash_elasticity

4

hash_max

512

hello_time

200

hello_timer

70

max_age

2000

multicast_last_member_count

2

multicast_last_member_interval

100

multicast_membership_interval

26000

multicast_querier

0

multicast_querier_interval

25500

multicast_query_interval

13000

multicast_query_response_interval

1000

multicast_query_use_ifaddr

0

multicast_router

1

multicast_snooping

1

multicast_startup_query_count

2

multicast_startup_query_interval

3125

Expand
表6.196 リンクの概要
Nameタイプ概要

host

ホスト

 

host_nic

HostNic

ホストネットワークインターフェイスへの参照。

network

ネットワーク

インターフェイスが接続されているネットワークへの参照。

qos

Qos

 

6.149. NetworkConfiguration 構造体
リンクのコピー

Expand
表6.197 属性の概要
Nameタイプ概要

dns

Dns

 

nics

Nic[]

 

6.150. NetworkFilter 構造体
リンクのコピー

ネットワークフィルターを使用すると、定義されたルールに従って、仮想マシンの nic との間で送受信されるパケットをフィルター処理できます。

libvirt に基づいてサポートされるネットワークフィルターには、いくつかのタイプがあります。さまざまなネットワークフィルターの詳細については、を参照してください。https://libvirt.org/firewall.html

libvirt のネットワークフィルターに加えて、追加のネットワークフィルターが 2 つあります。1 つ目は vdsm-no-mac-spoofing と呼ばれ、no-mac-spoofing および no-arp-mac-spoofing で設定されています。仮想マシンの nic にネットワークフィルターが定義されていない場合、2 番目の ovirt-no-filter が使用されます。ovirt-no-filter ネットワークフィルターは内部実装にのみ使用され、NIC には存在しません。

これは XML 表現の例です。 

<network_filter id="00000019-0019-0019-0019-00000000026c">
  <name>example-filter</name>
  <version>
    <major>4</major>
    <minor>0</minor>
    <build>-1</build>
    <revision>-1</revision>
  </version>
</network_filter>
Copy to Clipboard Toggle word wrap

バージョンの一部が存在しない場合は、-1 で表されます。

Expand
表6.198 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

version

バージョン

最初に導入された特定の NetworkFilter の最小サポート対象バージョンを表します。

6.151. NetworkLabel 構造体
リンクのコピー

ホストネットワークインターフェイスに追加できるラベルを表します。

Expand
表6.199 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.200 リンクの概要
Nameタイプ概要

host_nic

HostNic

 

network

ネットワーク

 

6.152. NetworkPluginType enum
リンクのコピー

Expand
表6.201 値の概要
Name概要

open_vswitch

 

6.153. NetworkStatus enum
リンクのコピー

Expand
表6.202 値の概要
Name概要

non_operational

 

operational

 

6.154. NetworkUsage enum
リンクのコピー

Expand
表6.203 値の概要
Name概要

display

 

gluster

ネットワークは Gluster (bricks)データトラフィックに使用されます。

management

 

migration

 

vm

 

6.155. NfsProfileDetail struct
リンクのコピー

Expand
表6.204 属性の概要
Nameタイプ概要

nfs_server_ip

String

 

profile_details

ProfileDetail[]

 

6.156. NfsVersion enum
リンクのコピー

Expand
表6.205 値の概要
Name概要

auto

 

v3

 

v4

 

v4_1

 

6.157. Nic 構造体
リンクのコピー

仮想マシンの NIC を表します。

たとえば、NIC の XML 表現は以下のようになります。 

<nic href="/ovirt-engine/api/vms/123/nics/456" id="456">
  <name>nic1</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <interface>virtio</interface>
  <linked>true</linked>
  <mac>
    <address>02:00:00:00:00:00</address>
  </mac>
  <plugged>true</plugged>
  <vnic_profile href="/ovirt-engine/api/vnicprofiles/789" id="789"/>
</nic>
Copy to Clipboard Toggle word wrap
Expand
表6.206 属性の概要
Nameタイプ概要

boot_protocol

BootProtocol

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

interface

NicInterface

NIC に使用されるドライバーのタイプ。

linked

ブール値

NIC が仮想マシンにリンクされているかどうかを定義します。

mac

Mac

インターフェイスの MAC アドレス。

name

String

人間が判読できるプレーンテキストでの名前。

on_boot

ブール値

 

plugged

ブール値

NIC が仮想マシンに接続されているかどうかを定義します。

Expand
表6.207 リンクの概要
Nameタイプ概要

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

network

ネットワーク

インターフェイスが接続するネットワークへの参照。

network_attachments

NetworkAttachment[]

 

network_labels

NetworkLabel[]

 

reported_devices

ReportedDevice[]

 

statistics

Statistic[]

NIC の統計へのリンク。

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

virtual_function_allowed_labels

NetworkLabel[]

 

virtual_function_allowed_networks

Network[]

 

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

vnic_profile

VnicProfile

 

6.158. NicConfiguration 構造体
リンクのコピー

Expand
表6.208 属性の概要
Nameタイプ概要

boot_protocol

BootProtocol

 

ip

Ip

 

name

String

 

on_boot

ブール値

 

6.159. NicInterface enum
リンクのコピー

Expand
表6.209 値の概要
Name概要

e1000

 

pci_passthrough

 

rtl8139

 

rtl8139_virtio

 

spapr_vlan

 

virtio

 

6.160. NicStatus enum
リンクのコピー

Expand
表6.210 値の概要
Name概要

down

 

up

 

6.161. NumaNode struct
リンクのコピー

物理 NUMA ノードを表します。

XML 表現の例: 

<host_numa_node href="/ovirt-engine/api/hosts/0923f1ea/numanodes/007cf1ab" id="007cf1ab">
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>65536</memory>
  <node_distance>40 20 40 10</node_distance>
  <host href="/ovirt-engine/api/hosts/0923f1ea" id="0923f1ea"/>
</host_numa_node>
Copy to Clipboard Toggle word wrap
Expand
表6.211 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

cpu

Cpu

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

index

Integer

 

memory

Integer

NUMA ノードのメモリー (MB)。

name

String

人間が判読できるプレーンテキストでの名前。

node_distance

String

 
Expand
表6.212 リンクの概要
Nameタイプ概要

host

ホスト

 

statistics

Statistic[]

 

6.162. NumaNodePin struct
リンクのコピー

仮想 NUMA ノードの物理 NUMA ノードへのピニングを表します。

Expand
表6.213 属性の概要
Nameタイプ概要

host_numa_node

NumaNode

非推奨 - 機能はありません。

index

Integer

仮想 NUMA ノードがピニングされている物理 NUMA ノードのインデックス。

pinned

ブール値

非推奨 - 常に true である必要があります。

6.163. NumaTuneMode enum
リンクのコピー

Expand
表6.214 値の概要
Name概要

interleave

 

preferred

 

strict

 

6.164. OpenStackImage 構造体
リンクのコピー

Expand
表6.215 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.216 リンクの概要
Nameタイプ概要

openstack_image_provider

OpenStackImageProvider

 

6.165. OpenStackImageProvider struct
リンクのコピー

Expand
表6.217 属性の概要
Nameタイプ概要

authentication_url

String

外部プロバイダー認証 URL アドレスを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

password

String

認証プロセス中にユーザーのパスワードを定義します。

properties

Property[]

プロバイダー名/値のプロパティーの配列。

requires_authentication

ブール値

プロバイダー認証が必要かどうかを定義します。

tenant_name

String

 

url

String

外部プロバイダーの URL アドレスを定義します。

username

String

認証プロセス中に使用されるユーザー名を定義します。

6.165.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

Expand
表6.218 リンクの概要
Nameタイプ概要

certificates

Certificate[]

 

images

OpenStackImage[]

 

6.166. OpenStackNetwork 構造体
リンクのコピー

Expand
表6.219 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.220 リンクの概要
Nameタイプ概要

openstack_network_provider

OpenStackNetworkProvider

 

6.167. OpenStackNetworkProvider 構造体
リンクのコピー

Expand
表6.221 属性の概要
Nameタイプ概要

agent_configuration

AgentConfiguration

エージェントの設定。

authentication_url

String

外部プロバイダー認証 URL アドレスを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

password

String

認証プロセス中にユーザーのパスワードを定義します。

plugin_type

NetworkPluginType

ネットワークプラグインのタイプ。

properties

Property[]

プロバイダー名/値のプロパティーの配列。

read_only

ブール値

プロバイダーが読み取り専用かどうかを示します。

requires_authentication

ブール値

プロバイダー認証が必要かどうかを定義します。

tenant_name

String

 

type

OpenStackNetworkProviderType

プロバイダーのタイプ。

url

String

外部プロバイダーの URL アドレスを定義します。

username

String

認証プロセス中に使用されるユーザー名を定義します。

6.167.1. read_only
リンクのコピー

プロバイダーが読み取り専用かどうかを示します。

読み取り専用プロバイダーでは、ネットワークまたはサブネットの追加、変更、または削除は許可されません。ポート関連の操作は、仮想 NIC のプロビジョニングに必要なため、許可されます。

6.167.2. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

Expand
表6.222 リンクの概要
Nameタイプ概要

certificates

Certificate[]

証明書リストへの参照。

networks

OpenStackNetwork[]

OpenStack ネットワークリストへの参照。

subnets

OpenStackSubnet[]

OpenStack ネットワークのサブネットリストへの参照。

6.168. OpenStackNetworkProviderType enum
リンクのコピー

OpenStack ネットワークプロバイダーは、OpenStack Neutron で実装できます。この場合、Neutron エージェントはホストに自動的にインストールされるか、OpenStack API を実装する外部プロバイダーにすることもできます。この場合、仮想インターフェイスドライバーはカスタムソリューションとして手動でインストールされます。

Expand
表6.223 値の概要
Name概要

external

プロバイダーが OpenStack Neutron API を実装する外部プロバイダーであることを示します。

neutron

プロバイダーが OpenStack Neutron であることを示します。

6.168.1. external
リンクのコピー

プロバイダーが OpenStack Neutron API を実装する外部プロバイダーであることを示します。この場合の仮想インターフェイスドライバーは、外部プロバイダーによって実装されます。

6.168.2. neutron
リンクのコピー

プロバイダーが OpenStack Neutron であることを示します。標準の OpenStack Neutron エージェントは、仮想インターフェイスドライバーとして使用されます。

6.169. OpenStackProvider 構造体
リンクのコピー

Expand
表6.224 属性の概要
Nameタイプ概要

authentication_url

String

外部プロバイダー認証 URL アドレスを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

password

String

認証プロセス中にユーザーのパスワードを定義します。

properties

Property[]

プロバイダー名/値のプロパティーの配列。

requires_authentication

ブール値

プロバイダー認証が必要かどうかを定義します。

tenant_name

String

 

url

String

外部プロバイダーの URL アドレスを定義します。

username

String

認証プロセス中に使用されるユーザー名を定義します。

6.169.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

6.170. OpenStackSubnet 構造体
リンクのコピー

Expand
表6.225 属性の概要
Nameタイプ概要

cidr

String

ネットワーク CIDR を定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

dns_servers

String[]

DNS サーバーのリストを定義します。

gateway

String

IP ゲートウェイを定義します。

id

String

一意の ID

ip_version

String

IP バージョンを定義します。

name

String

人間が判読できるプレーンテキストでの名前。

6.170.1. ip_version
リンクのコピー

IP バージョンを定義します。

IPv6 では、値は v4' for IPv4 or `v6 になります。

Expand
表6.226 リンクの概要
Nameタイプ概要

openstack_network

OpenStackNetwork

OpenStack ネットワークを管理するサービスへの参照。

6.171. OpenStackVolumeProvider 構造体
リンクのコピー

Expand
表6.227 属性の概要
Nameタイプ概要

authentication_url

String

外部プロバイダー認証 URL アドレスを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

password

String

認証プロセス中にユーザーのパスワードを定義します。

properties

Property[]

プロバイダー名/値のプロパティーの配列。

requires_authentication

ブール値

プロバイダー認証が必要かどうかを定義します。

tenant_name

String

 

url

String

外部プロバイダーの URL アドレスを定義します。

username

String

認証プロセス中に使用されるユーザー名を定義します。

6.171.1. requires_authentication
リンクのコピー

プロバイダー認証が必要かどうかを定義します。

認証が必要な場合、username と password の両方の属性が認証時に使用されます。

Expand
表6.228 リンクの概要
Nameタイプ概要

authentication_keys

OpenstackVolumeAuthenticationKey[]

 

certificates

Certificate[]

 

data_center

DataCenter

 

volume_types

OpenStackVolumeType[]

 

6.172. OpenStackVolumeType struct
リンクのコピー

Expand
表6.229 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

properties

Property[]

 
Expand
表6.230 リンクの概要
Nameタイプ概要

openstack_volume_provider

OpenStackVolumeProvider

 

6.173. OpenstackVolumeAuthenticationKey struct
リンクのコピー

Expand
表6.231 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

creation_date

日付

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

usage_type

OpenstackVolumeAuthenticationKeyUsageType

 

uuid

String

 

value

String

 
Expand
表6.232 リンクの概要
Nameタイプ概要

openstack_volume_provider

OpenStackVolumeProvider

 

6.174. OpenstackVolumeAuthenticationKeyUsageType enum
リンクのコピー

Expand
表6.233 値の概要
Name概要

ceph

 

6.175. OperatingSystem struct
リンクのコピー

オペレーティングシステムを説明する情報。仮想マシンとホストに使用されます。

Expand
表6.234 属性の概要
Nameタイプ概要

boot

Boot

 

cmdline

String

 

custom_kernel_cmdline

String

ホストカーネルコマンドラインのカスタム部分。

initrd

String

 

kernel

String

 

reported_kernel_cmdline

String

実行中のホストが報告するホストカーネルコマンドライン。

type

String

 

version

バージョン

 

6.175.1. custom_kernel_cmdline
リンクのコピー

ホストカーネルコマンドラインのカスタム部分。これは、既存のカーネルコマンドラインと統合されます。

この属性によって実装された変更を適用するには、ホストを再インストールしてから再起動する必要があります。

パラメーターのマージ：各ホストデプロイ手順で追加されたカーネルパラメーターは grubby --update-kernel DEFAULT --remove-args <previous_custom_params > を使用して削除され、現在のカーネルコマンドラインのカスタマイズは grubby --update-kernel DEFAULT --args <custom_params > を使用して適用されます。エンジンは、最後に適用されたカーネルパラメーターのカスタマイズを内部的に追跡します。

注記

この属性は現在、ホストに対してのみ使用されます。

6.175.2. reported_kernel_cmdline
リンクのコピー

実行中のホストが報告するホストカーネルコマンドライン。

読み取り専用属性。この属性を変更しようとしても、黙って無視されます。

注記

この属性は現在、ホストに対してのみ使用されます。

6.176. OperatingSystemInfo struct
リンクのコピー

Expand
表6.235 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

large_icon

アイコン

 

name

String

人間が判読できるプレーンテキストでの名前。

small_icon

アイコン

 

6.177. Option 構造体
リンクのコピー

Expand
表6.236 属性の概要
Nameタイプ概要

name

String

 

type

String

 

value

String

 

6.178. OsType enum
リンクのコピー

Expand
表6.237 値の概要
Name概要

other

 

other_linux

 

rhel_3

 

rhel_3x64

 

rhel_4

 

rhel_4x64

 

rhel_5

 

rhel_5x64

 

rhel_6

 

rhel_6x64

 

unassigned

 

windows_2003

 

windows_2003x64

 

windows_2008

 

windows_2008r2x64

 

windows_2008x64

 

windows_2012x64

 

windows_7

 

windows_7x64

 

windows_8

 

windows_8x64

 

windows_xp

 

6.179. Package struct
リンクのコピー

パッケージを表すタイプ。

これは、package 要素の例です。 

<package>
  <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
</package>
Copy to Clipboard Toggle word wrap
Expand
表6.238 属性の概要
Nameタイプ概要

name

String

パッケージの名前

6.180. Payload 構造体
リンクのコピー

Expand
表6.239 属性の概要
Nameタイプ概要

files

File[]

 

type

VmDeviceType

 

volume_id

String

 

6.181. PayloadEncoding enum
リンクのコピー

Expand
表6.240 値の概要
Name概要

base64

 

plaintext

 

6.182. Permission struct
リンクのコピー

Expand
表6.241 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.242 リンクの概要
Nameタイプ概要

cluster

Cluster

 

data_center

DataCenter

 

disk

ディスク

 

group

グループ

 

host

ホスト

 

role

ロール

 

storage_domain

StorageDomain

 

template

Template

 

user

User

 

vm

Vm

 

vm_pool

VmPool

 

6.183. Permit 構造体
リンクのコピー

タイプは permit を表します。

Expand
表6.243 属性の概要
Nameタイプ概要

administrative

ブール値

permit が管理上のものかどうかを指定します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.244 リンクの概要
Nameタイプ概要

role

ロール

permit が属するロールへの参照。

6.184. PmProxy 構造体
リンクのコピー

Expand
表6.245 属性の概要
Nameタイプ概要

type

PmProxyType

 

6.185. PmProxyType enum
リンクのコピー

Expand
表6.246 値の概要
Name概要

cluster

フェンスプロキシーは、フェンスされたホストと同じクラスターから選択されます。

dc

フェンスプロキシーは、フェンスされたホストと同じデータセンターから選択されます。

other_dc

フェンスプロキシーは、フェンスされたホストとは異なるデータセンターから選択されます。

6.186. PolicyUnitType enum
リンクのコピー

この列挙は、すべての内部ポリシーユニットタイプのタイプを保持します

Expand
表6.247 値の概要
Name概要

filter

 

load_balancing

 

weight

 

6.187. PortMirroring struct
リンクのコピー

6.188. PowerManagement struct
リンクのコピー

Expand
表6.248 属性の概要
Nameタイプ概要

address

String

ホストのホスト名または IP アドレスです。

agents

Agent[]

複数のフェンスが使用されている場合のフェンスエージェントオプションを指定します。

automatic_pm_enabled

ブール値

エネルギーを節約するために、ホストの自動電源制御を切り替えます。

enabled

ブール値

電源管理設定が有効か無効かを示します。

kdump_detection

ブール値

ホストをシャットダウンする前に、ホスト上で kdump が実行されているかどうかを判断するかどうかを切り替えます。

options

Option[]

オプション name="" および value="" 文字列で指定された、選択した type= のフェンシングオプション。

password

String

電源管理用の有効で堅牢なパスワード。

pm_proxies

PmProxy[]

電源管理プロキシーを決定します。

status

PowerManagementStatus

ホストの電源ステータスを決定します。

type

String

フェンシングデバイスのコード。

username

String

電源管理用の有効なユーザー名。

6.188.1. agents
リンクのコピー

複数のフェンスが使用されている場合のフェンスエージェントオプションを指定します。

order サブ要素を使用して、フェンスエージェントに優先順位を付けます。エージェントは、フェンスアクションが成功するまで、その順序に従って順次実行されます。2 つ以上のフェンスエージェントの順序が同じ場合、それらは同時に実行されます。その他のサブ要素には、type、ip、user、password、および options が含まれます。

6.188.2. automatic_pm_enabled
リンクのコピー

エネルギーを節約するために、ホストの自動電源制御を切り替えます。true に設定すると、クラスターの負荷が低い場合にホストの電源が自動的にオフになり、必要に応じて再び電源がオンになります。これは、ユーザーが無効にしない限り、ホスト作成時に true に設定されます。

6.188.3. kdump_detection
リンクのコピー

ホストをシャットダウンする前に、ホスト上で kdump が実行されているかどうかを判断するかどうかを切り替えます。true に設定すると、ホストは kdump プロセス中にシャットダウンしません。これは、ユーザーが無効にしない限り、ホストで電源管理が有効になっている場合に true に設定されます。

6.188.4. type
リンクのコピー

フェンシングデバイスのコード。

有効なフェンシングデバイスコードの一覧は、capabilities コレクションにあります。

6.189. PowerManagementStatus enum
リンクのコピー

Expand
表6.249 値の概要
Name概要

off

ホストは OFF です。

on

ホストが ON です。

unknown

不明なステータス。

6.190. Product 構造体
リンクのコピー

Expand
表6.250 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

6.191. ProductInfo struct
リンクのコピー

製品情報です。

エントリーポイントには、API ユーザーが Red Hat Virtualization 環境の正当性を判断するのに役立つ product_info 要素が含まれています。これには、製品名、vendor、version 含まれます。

本物の Red Hat Virtualization 環境を検証する

以下の要素は、本物の Red Hat Virtualization 環境を識別します。 

<api>
...
<product_info>
  <name>oVirt Engine</name>
  <vendor>ovirt.org</vendor>
  <version>
    <build>0</build>
    <full_version>4.1.0_master</full_version>
    <major>4</major>
    <minor>1</minor>
    <revision>0</revision>
  </version>
</product_info>
...
</api>
Copy to Clipboard Toggle word wrap
Expand
表6.251 属性の概要
Nameタイプ概要

name

String

oVirt Engine などの製品名です。

vendor

String

ベンダーの名前 (例: `ovirt)。

version

バージョン

製品のバージョン番号。

6.191.1. vendor
リンクのコピー

ベンダーの名前 (例: ovirt.org)。

6.192. ProfileDetail struct
リンクのコピー

Expand
表6.252 属性の概要
Nameタイプ概要

block_statistics

BlockStatistic[]

 

duration

Integer

 

fop_statistics

FopStatistic[]

 

profile_type

String

 

statistics

Statistic[]

 

6.193. Property 構造体
リンクのコピー

Expand
表6.253 属性の概要
Nameタイプ概要

name

String

 

value

String

 

6.194. ProxyTicket struct
リンクのコピー

Expand
表6.254 属性の概要
Nameタイプ概要

value

String

 

6.195. Qos struct
リンクのコピー

このタイプは、サービスの品質 (QoS) を定義する属性を表します。

ストレージの type は storage で、属性 max_throughput、max_read_throughput、max_write_throughput、max_iops、max_read_iops および max_write_iops が関連しています。

コンピューティング機能を持つリソースの場合、type は cpu で、属性 cpu_limit が関連しています。

仮想マシンネットワークの type は network で、属性 inbound_average、inbound_peak、inbound_burst、outbound_average、outbound_peak、および outbound_burst が関連しています。

ホストネットワークの場合、type は hostnetwork で、属性 outbound_average_linkshare、outbound_average_upperlimit、および outbound_average_realtime が関連しています。

Expand
表6.255 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

cpu_limit

Integer

最大処理能力 (単位: %)。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

inbound_average

Integer

Mbps 単位の望ましい平均インバウンドビットレート。

inbound_burst

Integer

1 回のバーストで配信できるデータ量(MiB 単位)。

inbound_peak

Integer

最大インバウンドレート(Mbps)。

max_iops

Integer

1 秒あたりの最大許容入出力操作数。

max_read_iops

Integer

1 秒あたりの最大許容入力操作数。

max_read_throughput

Integer

読み取り操作の最大許容スループット。

max_throughput

Integer

最大許容総スループット。

max_write_iops

Integer

1 秒あたりの最大許容出力操作数。

max_write_throughput

Integer

書き込み操作の最大許容スループット。

name

String

人間が判読できるプレーンテキストでの名前。

outbound_average

Integer

Mbps 単位の望ましい平均アウトバウンドビットレート。

outbound_average_linkshare

Integer

重み共有。

outbound_average_realtime

Integer

Mbps 単位のコミットされたレート。

outbound_average_upperlimit

Integer

ネットワークが使用する最大帯域幅(Mbps 単位)。

outbound_burst

Integer

MiB 単位の 1 回のバーストで送信できるデータの量。

outbound_peak

Integer

Mbps 単位の最大アウトバウンドレート。

type

QosType

このエントリーに割り当てることができるリソースの種類。

6.195.1. cpu_limit
リンクのコピー

最大処理能力 (単位: %)。

コンピューティングリソースの設定に使用されます。

6.195.2. inbound_average
リンクのコピー

Mbps 単位の望ましい平均インバウンドビットレート。

仮想マシンのネットワークを設定するために使用します。定義されている場合、inbound_peak と inbound_burst も設定される必要があります。

詳細は、Libvirt-QOS を参照してください。

6.195.3. inbound_burst
リンクのコピー

1 回のバーストで配信できるデータ量(MiB 単位)。

仮想マシンのネットワークを設定するために使用します。定義されている場合、inbound_average と inbound_peak も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

6.195.4. inbound_peak
リンクのコピー

最大インバウンドレート(Mbps)。

仮想マシンのネットワークを設定するために使用します。定義されている場合、inbound_average と inbound_burst も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

6.195.5. max_iops
リンクのコピー

1 秒あたりの最大許容入出力操作数。

ストレージの設定に使用されます。max_read_iops または max_write_iops が設定されている場合、設定することはできません。

6.195.6. max_read_iops
リンクのコピー

1 秒あたりの最大許容入力操作数。

ストレージの設定に使用されます。max_iops が設定されている場合、設定することはできません。

6.195.7. max_read_throughput
リンクのコピー

読み取り操作の最大許容スループット。

ストレージの設定に使用されます。max_throughput が設定されている場合は、設定することはできません。

6.195.8. max_throughput
リンクのコピー

最大許容総スループット。

ストレージの設定に使用されます。max_read_throughput または max_write_throughput が設定されている場合、設定することはできません。

6.195.9. max_write_iops
リンクのコピー

1 秒あたりの最大許容出力操作数。

ストレージの設定に使用されます。max_iops が設定されている場合、設定することはできません。

6.195.10. max_write_throughput
リンクのコピー

書き込み操作の最大許容スループット。

ストレージの設定に使用されます。max_throughput が設定されている場合は、設定することはできません。

6.195.11. outbound_average
リンクのコピー

Mbps 単位の望ましい平均アウトバウンドビットレート。

仮想マシンのネットワークを設定するために使用します。定義されている場合、outbound_peak と outbound_burst も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

6.195.12. outbound_average_linkshare
リンクのコピー

重み共有。

ホストネットワークの設定に使用されます。同じ論理リンクリンクにアタッチされた他のネットワークと比較して、特定のネットワークに割り当てる必要がある論理リンクの容量を指定します。正確な共有は、そのリンクの全ネットワークの共有の合計によって異なります。デフォルトでは、この値は 1-100 の範囲の数字になります。

6.195.13. outbound_average_realtime
リンクのコピー

Mbps 単位のコミットされたレート。

ホストネットワークの設定に使用されます。ネットワークに必要な最小帯域幅。要求される Committed Rate は保証されず、ネットワークインフラストラクチャーおよび同じ論理リンクの他のネットワークによって要求される Commmitted Rate によって異なります。

6.195.14. outbound_average_upperlimit
リンクのコピー

ネットワークが使用する最大帯域幅(Mbps 単位)。

ホストネットワークの設定に使用されます。outboundAverageUpperlimit と outbound_average_realtime が提供される場合、outbound_averageUpperlimit は outbound_average_realtime より低くすることはできません。

詳細は、Libvirt-QOS を参照してください。

6.195.15. outbound_burst
リンクのコピー

MiB 単位の 1 回のバーストで送信できるデータの量。

仮想マシンのネットワークを設定するために使用します。定義されている場合、outbound_average と outbound_peak も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

6.195.16. outbound_peak
リンクのコピー

Mbps 単位の最大アウトバウンドレート。

仮想マシンのネットワークを設定するために使用します。定義されている場合、outbound_average と outbound_burst も設定する必要があります。

詳細は、Libvirt-QOS を参照してください。

Expand
表6.256 リンクの概要
Nameタイプ概要

data_center

DataCenter

QoS が関連付けられているデータセンター。

6.196. QosType enum
リンクのコピー

このタイプは、Quality of service (QoS) を割り当てることができるリソースのタイプを表します。

Expand
表6.257 値の概要
Name概要

cpu

Quality of service (QoS) は、コンピューティング機能を持つリソースに割り当てることができます。

hostnetwork

Quality of service (QoS) は、ホストネットワークに割り当てることができます。

network

Quality of service (QoS) は、仮想マシンネットワークに割り当てることができます。

storage

Quality of service (QoS) は、ストレージに割り当てることができます。

6.197. Quota 構造体
リンクのコピー

クォータオブジェクトを表します。

クォータの XML 表現の例: 

<quota href="/ovirt-engine/api/datacenters/7044934e/quotas/dcad5ddc" id="dcad5ddc">
  <name>My Quota</name>
  <description>A quota for my oVirt environment</description>
  <cluster_hard_limit_pct>0</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>0</cluster_soft_limit_pct>
  <data_center href="/ovirt-engine/api/datacenters/7044934e" id="7044934e"/>
  <storage_hard_limit_pct>0</storage_hard_limit_pct>
  <storage_soft_limit_pct>0</storage_soft_limit_pct>
</quota>
Copy to Clipboard Toggle word wrap
Expand
表6.258 属性の概要
Nameタイプ概要

cluster_hard_limit_pct

Integer

 

cluster_soft_limit_pct

Integer

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

data_center

DataCenter

 

description

String

プレーンテキストでの人間が判読できる説明。

disks

Disk[]

 

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

storage_hard_limit_pct

Integer

 

storage_soft_limit_pct

Integer

 

users

User[]

 

vms

Vm[]

 
Expand
表6.259 リンクの概要
Nameタイプ概要

permissions

Permission[]

 

quota_cluster_limits

QuotaClusterLimit[]

 

quota_storage_limits

QuotaStorageLimit[]

 

6.198. QuotaClusterLimit struct
リンクのコピー

Expand
表6.260 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

memory_limit

10 進数

 

memory_usage

10 進数

 

name

String

人間が判読できるプレーンテキストでの名前。

vcpu_limit

Integer

 

vcpu_usage

Integer

 
Expand
表6.261 リンクの概要
Nameタイプ概要

cluster

Cluster

 

quota

クォータ

 

6.199. QuotaModeType enum
リンクのコピー

Expand
表6.262 値の概要
Name概要

audit

 

disabled

 

enabled

 

6.200. QuotaStorageLimit struct
リンクのコピー

Expand
表6.263 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

limit

Integer

 

name

String

人間が判読できるプレーンテキストでの名前。

使用方法

10 進数

 
Expand
表6.264 リンクの概要
Nameタイプ概要

quota

クォータ

 

storage_domain

StorageDomain

 

6.201. Range 構造体
リンクのコピー

Expand
表6.265 属性の概要
Nameタイプ概要

from

String

 

上記を以下のように変更します。

String

 

6.202. Rate 構造体
リンクのコピー

乱数ジェネレーターデバイスからの最大バイト消費速度を決定します。

Expand
表6.266 属性の概要
Nameタイプ概要

bytes

Integer

期間ごとに消費できるバイト数。

period

Integer

1 期間の長さ (ミリ秒単位)。

6.203. ReportedConfiguration 構造体
リンクのコピー

Expand
表6.267 属性の概要
Nameタイプ概要

actual_value

String

 

expected_value

String

 

in_sync

ブール値

ネットワークアタッチメントにコミットされていないネットワーク設定が含まれている場合は false。

name

String

 

6.204. ReportedDevice 構造体
リンクのコピー

Expand
表6.268 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

ips

Ip[]

 

mac

Mac

 

name

String

人間が判読できるプレーンテキストでの名前。

type

ReportedDeviceType

 
Expand
表6.269 リンクの概要
Nameタイプ概要

vm

Vm

 

6.205. ReportedDeviceType enum
リンクのコピー

Expand
表6.270 値の概要
Name概要

network

 

6.206. ResolutionType enum
リンクのコピー

Expand
表6.271 値の概要
Name概要

add

 

copy

 

6.207. RngDevice 構造体
リンクのコピー

乱数ジェネレーター (RNG) デバイスモデル。

Expand
表6.272 属性の概要
Nameタイプ概要

rate

Rate

乱数ジェネレーターデバイスからの最大バイト消費速度を決定します。

source

RngSource

乱数ジェネレーターデバイスのバックエンド。

6.208. RngSource enum
リンクのコピー

乱数ジェネレーターのバックエンドタイプを表します。

Expand
表6.273 値の概要
Name概要

hwrng

/dev/hwrng (通常は特殊な HW ジェネレーター) デバイスからランダムデータを取得します。

random

/dev/random デバイスからランダムデータを取得します。

6.209. Role 構造体
リンクのコピー

システムロールを表します。

Expand
表6.274 属性の概要
Nameタイプ概要

administrative

ブール値

ロールを管理専用にするかどうかを定義します。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

mutable

ブール値

ロールを更新または削除する機能を定義します。

name

String

人間が判読できるプレーンテキストでの名前。

6.209.1. mutable
リンクのコピー

ロールを更新または削除する機能を定義します。

mutable が false に設定されているロールは、定義済みのロールです。

Expand
表6.275 リンクの概要
Nameタイプ概要

permits

Permit[]

ロール permits の permits サブコレクションへのリンク。

user

User

 

6.210. RoleType enum
リンクのコピー

ロールが管理ロールかどうかを表すタイプ。少なくとも 1 つの管理ロールを付与されたユーザーは、管理者と見なされます。

Expand
表6.276 値の概要
Name概要

admin

管理ロール。

user

ユーザーロール。

6.211. SchedulingPolicy struct
リンクのコピー

Expand
表6.277 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

default_policy

ブール値

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

locked

ブール値

 

name

String

人間が判読できるプレーンテキストでの名前。

properties

Property[]

 
Expand
表6.278 リンクの概要
Nameタイプ概要

balances

Balance[]

 

filters

Filter[]

 

weight

Weight[]

 

6.212. SchedulingPolicyUnit struct
リンクのコピー

Expand
表6.279 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

enabled

ブール値

 

id

String

一意の ID

internal

ブール値

 

name

String

人間が判読できるプレーンテキストでの名前。

properties

Property[]

 

type

PolicyUnitType

 

6.213. ScsiGenericIO enum
リンクのコピー

Expand
表6.280 値の概要
Name概要

filtered

 

unfiltered

 

6.214. SeLinux 構造体
リンクのコピー

Expand
表6.281 属性の概要
Nameタイプ概要

mode

SeLinuxMode

 

6.215. SeLinuxMode enum
リンクのコピー

Expand
表6.282 値の概要
Name概要

disabled

 

enforcing

 

permissive

 

6.216. SerialNumber 構造体
リンクのコピー

Expand
表6.283 属性の概要
Nameタイプ概要

policy

SerialNumberPolicy

 

value

String

 

6.217. SerialNumberPolicy enum
リンクのコピー

Expand
表6.284 値の概要
Name概要

custom

 

host

 

vm

 

6.218. Session 構造体
リンクのコピー

仮想マシンへのユーザーセッションについて説明します。

Expand
表6.285 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

console_user

ブール値

これがコンソールセッションであるかどうかを示します。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

ip

Ip

IP アドレスユーザーが接続している。

name

String

人間が判読できるプレーンテキストでの名前。

protocol

String

セッションで使用されるプロトコル。

6.218.1. console_user
リンクのコピー

これがコンソールセッションであるかどうかを示します。

コンソールユーザーの場合、値は true になります。SPICE または VNC、その他の場合は false になります(RDP、SSH など)。

6.218.2. ip
リンクのコピー

IP アドレスユーザーが接続している。

現在、コンソールユーザーのみが利用できます。

6.218.3. protocol
リンクのコピー

セッションで使用されるプロトコル。

現在使用されていません。これは、SPICE、VNC、SSH、RDP などのユーザーの接続方法に関する情報を対象としています。

Expand
表6.286 リンクの概要
Nameタイプ概要

user

User

このセッションに関連するユーザー。

vm

Vm

このセッションに関連する仮想マシンへのリンク。

6.219. SkipIfConnectivityBroken struct
リンクのコピー

Expand
表6.287 属性の概要
Nameタイプ概要

enabled

ブール値

有効にすると、クラスター内の設定可能なパーセンテージを超えるホストが接続を失ってもホストのフェンシングは実行されません。

threshold

Integer

接続テストのしきい値。

6.219.1. enabled
リンクのコピー

有効にすると、クラスター内の設定可能なパーセンテージを超えるホストが接続を失ってもホストのフェンシングは実行されません。これは、クラスター内でグローバルネットワークの問題が発生した場合にフェンシング ストーム を防ぐためです。

6.219.2. threshold
リンクのコピー

接続テストのしきい値。少なくともクラスター内のホストのしきい値パーセンテージで接続が失われた場合、フェンシングは行われません。

6.220. SkipIfSdActive struct
リンクのコピー

このタイプは、フェンシングポリシーのストレージ関連の設定を表します。

Expand
表6.288 属性の概要
Nameタイプ概要

enabled

ブール値

有効にすると、ホストがストレージでリースを維持している場合にフェンシングをスキップします。

6.220.1. enabled
リンクのコピー

有効にすると、ホストがストレージでリースを維持している場合にフェンシングをスキップします。これは、ホストがまだストレージにアクセスできる場合、フェンシングされないことを意味します。

6.221. Snapshot 構造体
リンクのコピー

スナップショットオブジェクトを表します。 

<snapshot id="456" href="/ovirt-engine/api/vms/123/snapshots/456">
  <actions>
    <link rel="restore" href="/ovirt-engine/api/vms/123/snapshots/456/restore"/>
  </actions>
  <vm id="123" href="/ovirt-engine/api/vms/123"/>
  <description>Virtual Machine 1 - Snapshot A</description>
  <type>active</type>
  <date>2010-08-16T14:24:29</date>
  <persist_memorystate>false</persist_memorystate>
</snapshot>
Copy to Clipboard Toggle word wrap
Expand
表6.289 属性の概要
Nameタイプ概要

bios

Bios

仮想マシンの BIOS 設定への参照。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

console

コンソール

この仮想マシン用に設定されたコンソール。

cpu

Cpu

仮想マシン CPU の設定。

cpu_shares

Integer

 

creation_time

日付

仮想マシンの作成日。

custom_compatibility_version

バージョン

仮想マシンのカスタム互換性バージョン。

custom_cpu_model

String

 

custom_emulated_machine

String

 

custom_properties

CustomProperty[]

さまざまなフックを設定するために VDSM に送信されるプロパティー。

date

日付

 

delete_protected

ブール値

true の場合、仮想マシンは削除できません。

description

String

プレーンテキストでの人間が判読できる説明。

display

表示

仮想マシンの表示設定。

domain

Domain

この仮想マシン用に設定されたドメイン。

fqdn

String

仮想マシンの完全修飾ドメイン名。

guest_operating_system

GuestOperatingSystem

仮想マシンにインストールされているオペレーティングシステム。

guest_time_zone

TimeZone

仮想マシンが使用するタイムゾーン (ゲストエージェントによって返されます)。

high_availability

高可用性

仮想マシンの高可用性設定。

id

String

一意の ID

initialization

初期化

仮想マシンの初期化設定への参照。

io

Io

IO スレッドのパフォーマンスチューニング用。

large_icon

アイコン

仮想マシンの大きなアイコン。

memory

Integer

仮想マシンのメモリー (バイト単位)。

memory_policy

MemoryPolicy

仮想マシンのメモリー管理設定への参照。

migration

MigrationOptions

実行中の仮想マシンの別のホストへの移行設定への参照。

migration_downtime

Integer

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

name

String

人間が判読できるプレーンテキストでの名前。

next_run_configuration_exists

ブール値

仮想マシンの設定が変更されたため、仮想マシンの再起動が必要です。

numa_tune_mode

NumaTuneMode

NUMA トポロジーの適用方法。

origin

String

この仮想マシンのオリジン。

os

OperatingSystem

仮想マシンにインストールされているオペレーティングシステムのタイプ。

payloads

Payload[]

仮想マシンのオプションのペイロード。ISO が仮想マシンを設定するために使用されます。

persist_memorystate

ブール値

 

placement_policy

VmPlacementPolicy

仮想マシンの配置ポリシーの設定。

rng_device

RngDevice

この仮想マシンの乱数ジェネレーターデバイスの設定。

run_once

ブール値

true の場合、仮想マシンは run once コマンドを使用して開始されています。つまり、この 1 回の実行のために保存されている設定とは異なる可能性があります。

serial_number

SerialNumber

クラスター内の仮想マシンのシリアル番号。

small_icon

アイコン

仮想マシンの小さなアイコン。

snapshot_status

SnapshotStatus

 

snapshot_type

SnapshotType

 

soundcard_enabled

ブール値

true の場合、サウンドカードが仮想マシンに追加されます。

sso

Sso

この仮想マシンが設定されているシングルサインオン設定への参照。

start_paused

ブール値

true の場合、仮想マシンは起動後、最初は 'paused' 状態になります。

start_time

日付

仮想マシンが起動された日付。

stateless

ブール値

true の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。

status

VmStatus

仮想マシンの現在の状態

status_detail

String

人間が読める現在のステータスの詳細。

stop_reason

String

仮想マシンが停止した理由。

stop_time

日付

仮想マシンが停止された日付。

time_zone

TimeZone

oVirt によって設定された仮想マシンのタイムゾーン。

tunnel_migration

ブール値

true の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。

type

VmType

仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。

usb

Usb

この仮想マシンの USB デバイスの設定 (カウント、タイプ)。

use_latest_template_version

ブール値

true の場合、仮想マシンは起動時にテンプレートの最新バージョンに再設定されます。

virtio_scsi

VirtioScsi

VirtIO SCSI 設定への参照。

6.221.1. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>
Copy to Clipboard Toggle word wrap

6.221.2. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

仮想マシンを独自の互換性バージョンにカスタマイズできるようにします。custom_compatibility_version が設定されている場合、この特定の仮想マシンのクラスター互換性バージョンをオーバーライドします。

仮想マシンの互換バージョンは、仮想マシンが格納されているデータセンターによって制限され、仮想マシンが実行される予定のホストの機能に対してチェックされます。

6.221.3. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

6.221.4. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.221.5. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>
Copy to Clipboard Toggle word wrap
注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 230 バイト = 1073741824 バイト。

注記

メモリーホットプラグは、Red Hat Virtualization 3.6 以降でサポートされています。上記の例では、仮想マシンの実行中にメモリーを増やすことができます。

6.221.6. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

6.221.7. next_run_configuration_exists
リンクのコピー

仮想マシンの設定が変更されたため、仮想マシンの再起動が必要です。変更された設定は、仮想マシンの シャットダウン 処理時に適用されます。

6.221.8. origin
リンクのコピー

この仮想マシンのオリジン。

値:

  • ovirt
  • rhev
  • vmware
  • xen
  • external
  • hosted_engine
  • managed_hosted_engine
  • kvm
  • physical_machine
  • hyperv

6.221.9. placement_policy
リンクのコピー

仮想マシンの配置ポリシーの設定。

この設定を更新して、仮想マシンを 1 つ以上のホストにピニングできます。

注記

複数のホストにピニングされた仮想マシンはライブマイグレーションできませんが、ホストに障害が発生した場合、高可用性になるように設定された仮想マシンは、仮想マシンがピニングされている他のホストの 1 つで自動的に再起動されます。

たとえば、仮想マシンを 2 つのホストに固定するには、以下のリクエストを送信します。 

PUT /api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>
Copy to Clipboard Toggle word wrap

6.221.10. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.221.11. sso
リンクのコピー

この仮想マシンが設定されているシングルサインオン設定への参照。コンソールを開くと、ユーザーは仮想マシンのオペレーティングシステムに自動的にサインインできます。

6.221.12. stop_reason
リンクのコピー

仮想マシンが停止した理由。オプションで、仮想マシンをシャットダウンするときにユーザーが設定します。

Expand
表6.290 リンクの概要
Nameタイプ概要

affinity_labels

AffinityLabel[]

オプション。

applications

Application[]

仮想マシンにインストールされているアプリケーションのリスト。

cdroms

Cdrom[]

CDROM にマウントされた ISO への参照。

cluster

Cluster

仮想マシンが属するクラスターへの参照。

cpu_profile

CpuProfile

この仮想マシンによって使用される CPU プロファイルへの参照。

disk_attachments

DiskAttachment[]

仮想マシンにアタッチされているディスクへの参照。

external_host_provider

ExternalHostProvider

 

floppies

Floppy[]

フロッピーにマウントされた ISO への参照。

graphics_consoles

GraphicsConsole[]

この仮想マシン用に設定されたグラフィックコンソールのリスト。

host

ホスト

仮想マシンが実行されているホストへの参照。

host_devices

HostDevice[]

この仮想マシンに関連付けられているデバイスへの参照。

instance_type

InstanceType

仮想マシンの設定は、インスタンスタイプの 1 つを介してオプションで事前定義できます。

katello_errata

KatelloErratum[]

仮想マシンに割り当てられたすべての Katello エラータを一覧表示します。

nics

Nic[]

仮想マシン上のネットワークインターフェイスデバイスのリストを参照します。

numa_nodes

NumaNode[]

この仮想マシンで使用される NUMA ノード設定を参照します。

permissions

Permission[]

この仮想マシンに設定されたパーミッション。

quota

クォータ

この仮想マシンに設定されたクォータ設定への参照。

reported_devices

ReportedDevice[]

 

sessions

Session[]

この仮想マシンに対して開かれているユーザーセッションのリスト。

snapshots

Snapshot[]

仮想マシンから取得されたすべてのスナップショットを参照します。

statistics

Statistic[]

この仮想マシンから収集された統計データ。

storage_domain

StorageDomain

仮想マシンが属するストレージドメインへの参照。

tags

Tag[]

 

template

Template

仮想マシンがベースとするテンプレートへの参照。

vm

Vm

 

vm_pool

VmPool

仮想マシンが任意のメンバーであるプールへの参照。

watchdogs

Watchdog[]

ウォッチドッグ設定への参照。

6.222. SnapshotStatus enum
リンクのコピー

Expand
表6.291 値の概要
Name概要

in_preview

 

locked

 

ok

 

6.223. SnapshotType enum
リンクのコピー

Expand
表6.292 値の概要
Name概要

active

 

preview

 

regular

 

stateless

 

6.224. SpecialObjects 構造体
リンクのコピー

このタイプには、空のテンプレートやタグ階層のルートなどの特殊オブジェクトへの参照が含まれます。

Expand
表6.293 リンクの概要
Nameタイプ概要

blank_template

Template

空のテンプレートへの参照。

root_tag

タグ

タグ階層のルートへの参照。

6.225. Spm 構造体
リンクのコピー

Expand
表6.294 属性の概要
Nameタイプ概要

priority

Integer

 

status

SpmStatus

 

6.226. SpmStatus enum
リンクのコピー

Expand
表6.295 値の概要
Name概要

contending

 

none

 

spm

 

6.227. Ssh 構造体
リンクのコピー

Expand
表6.296 属性の概要
Nameタイプ概要

authentication_method

SshAuthenticationMethod

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

fingerprint

String

 

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

port

Integer

 

user

User

 

6.228. SshAuthenticationMethod enum
リンクのコピー

Expand
表6.297 値の概要
Name概要

password

 

publickey

 

6.229. SshPublicKey struct
リンクのコピー

Expand
表6.298 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

content

String

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.299 リンクの概要
Nameタイプ概要

user

User

 

6.230. Sso 構造体
リンクのコピー

Expand
表6.300 属性の概要
Nameタイプ概要

メソッド

Method[]

 

6.231. SsoMethod enum
リンクのコピー

Expand
表6.301 値の概要
Name概要

guest_agent

 

6.232. 統計 struct
リンクのコピー

すべての種類の統計に使用されるジェネリックタイプ。

統計には、さまざまなエンティティーの統計値が含まれています。次のオブジェクトには統計が含まれています:

  • ディスク
  • ホスト
  • HostNic
  • NumaNode
  • Nic
  • Vm
  • GlusterBrick
  • Step
  • GlusterVolume

XML 表現の例: 

<statistics>
  <statistic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234/statistics/1234">
    <name>data.current.rx</name>
    <description>Receive data rate</description>
    <values type="DECIMAL">
      <value>
        <datum>0</datum>
      </value>
    </values>
    <type>GAUGE</type>
    <unit>BYTES_PER_SECOND</unit>
    <host_nic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234"/>
  </statistic>
  ...
</statistics>
Copy to Clipboard Toggle word wrap
注記

この統計サブコレクションは読み取り専用です。

Expand
表6.302 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

kind

StatisticKind

統計測定値のタイプ。

name

String

人間が判読できるプレーンテキストでの名前。

type

ValueType

後続の統計値のデータタイプ。

unit

StatisticUnit

統計値を測定する単位または割合。

値

Value[]

datum を含むデータセット。

Expand
表6.303 リンクの概要
Nameタイプ概要

brick

GlusterBrick

 

disk

ディスク

含まれる disk リソースとの関係。

gluster_volume

GlusterVolume

 

host

ホスト

 

host_nic

HostNic

ホスト NIC への参照。

host_numa_node

NumaNode

 

nic

Nic

 

step

Step

 

vm

Vm

 

6.233. StatisticKind enum
リンクのコピー

Expand
表6.304 値の概要
Name概要

カウンター

 

ゲージ

 

6.234. StatisticUnit enum
リンクのコピー

Expand
表6.305 値の概要
Name概要

bits_per_second

 

bytes

 

bytes_per_second

 

count_per_second

 

none

 

percent

 

秒

 

6.235. Step 構造体
リンクのコピー

job 実行の一部であるステップを表します。ステップは、より広いシーケンスの一部である特定の実行ユニットを記述および追跡するために使用されます。一部のステップでは、進行状況の報告がサポートされています。

Expand
表6.306 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

end_time

日付

ステップの終了時刻。

external

ブール値

ステップが外部システムによって開始されたかどうかを示します。

external_type

ExternalSystemType

ステップが参照する外部システム。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

number

Integer

現在の階層レベルでのステップの順序。

start_time

日付

ステップの開始時間。

status

StepStatus

ステップのステータス。

type

StepEnum

ステップのタイプ。

6.235.1. external
リンクのコピー

ステップが外部システムによって開始されたかどうかを示します。外部ステップは、ステップの作成者によって外部で管理されます。

Expand
表6.307 リンクの概要
Nameタイプ概要

job

Job

現在のステップ階層の最上位にある job を参照します。

parent_step

Step

階層内の現在のステップの親ステップを参照します。

statistics

Statistic[]

 

6.236. StepEnum enum
リンクのコピー

ステップタイプを表すタイプ。

Expand
表6.308 値の概要
Name概要

executing

実行中のステップタイプ。

finalizing

最終処理中のステップタイプ。

rebalancing_volume

rebalancing volume ステップタイプ。

removing_bricks

removing bricks ステップタイプ。

unknown

不明なステップタイプ。

validating

検証ステップタイプ。

6.236.1. executing
リンクのコピー

実行中のステップタイプ。ジョブのメイン実行ブロックを追跡するために使用されます。通常、これは実行ステップの一部を説明するいくつかのサブステップの親ステップになります。

6.236.2. finalizing
リンクのコピー

最終処理中のステップタイプ。job を完了するために必要な実行後のステップについて説明します。

6.236.3. rebalancing_volume
リンクのコピー

rebalancing volume ステップタイプ。Gluster フローの一部であるステップタイプについて説明します。

6.236.4. removing_bricks
リンクのコピー

removing bricks ステップタイプ。Gluster フローの一部であるステップタイプについて説明します。

6.236.5. unknown
リンクのコピー

不明なステップタイプ。起源が不明なステップタイプについて説明します。

6.236.6. validating
リンクのコピー

検証ステップタイプ。実行前に、パラメーターの正常性とパラメーターの有効性を検証するために使用されます。

6.237. StepStatus enum
リンクのコピー

ステップのステータスを表します。

Expand
表6.309 値の概要
Name概要

aborted

中止されたステップのステータス。

failed

失敗したステップのステータス。

finished

終了したステップのステータス。

started

開始されたステップのステータス。

unknown

不明なステップステータス。

6.237.1. aborted
リンクのコピー

中止されたステップのステータス。このステータスは、強制的に中止された外部ステップに適用されます。

6.237.2. finished
リンクのコピー

終了したステップのステータス。このステータスは、完了したステップの実行を示しています。

6.237.3. started
リンクのコピー

開始されたステップのステータス。このステータスは、現在実行中のステップを表します。

6.237.4. unknown
リンクのコピー

不明なステップステータス。このステータスは、解決方法が不明なステップ、つまり、システムが予期せず再起動される前に実行されたステップを表します。

6.238. StorageConnection 構造体
リンクのコピー

ストレージサーバー接続を表します。

以下に例を示します。 

<storage_connection id="123">
  <address>mynfs.example.com</address>
  <type>nfs</type>
  <path>/exports/mydata</path>
</storage_connection>
Copy to Clipboard Toggle word wrap
Expand
表6.310 属性の概要
Nameタイプ概要

address

String

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

mount_options

String

 

name

String

人間が判読できるプレーンテキストでの名前。

nfs_retrans

Integer

 

nfs_timeo

Integer

 

nfs_version

NfsVersion

 

password

String

 

path

String

 

port

Integer

 

portal

String

 

target

String

 

type

StorageType

 

username

String

 

vfs_type

String

 
Expand
表6.311 リンクの概要
Nameタイプ概要

host

ホスト

 

6.239. StorageConnectionExtension 構造体
リンクのコピー

Expand
表6.312 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

password

String

 

target

String

 

username

String

 
Expand
表6.313 リンクの概要
Nameタイプ概要

host

ホスト

 

6.240. StorageDomain 構造体
リンクのコピー

ストレージドメイン。

識別子 123 を持つ NFS ストレージドメインの XML 表現です。 

<storage_domain href="/ovirt-engine/api/storagedomains/123" id="123">
  <name>mydata</name>
  <description>My data</description>
  <available>38654705664</available>
  <committed>1073741824</committed>
  <critical_space_action_blocker>5</critical_space_action_blocker>
  <external_status>ok</external_status>
  <master>true</master>
  <storage>
    <address>mynfs.example.com</address>
    <nfs_version>v3</nfs_version>
    <path>/exports/mydata</path>
    <type>nfs</type>
  </storage>
  <storage_format>v3</storage_format>
  <type>data</type>
  <used>13958643712</used>
  <warning_low_space_indicator>10</warning_low_space_indicator>
  <wipe_after_delete>false</wipe_after_delete>
  <data_centers>
    <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
  </data_centers>
</storage_domain>
Copy to Clipboard Toggle word wrap
Expand
表6.314 属性の概要
Nameタイプ概要

available

Integer

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

committed

Integer

 

critical_space_action_blocker

Integer

 

description

String

プレーンテキストでの人間が判読できる説明。

external_status

ExternalStatus

 

id

String

一意の ID

import

ブール値

 

マスター

ブール値

 

name

String

人間が判読できるプレーンテキストでの名前。

status

StorageDomainStatus

 

storage

HostStorage

 

storage_format

StorageFormat

 

type

StorageDomainType

 

used

Integer

 

warning_low_space_indicator

Integer

 

wipe_after_delete

ブール値

この ストレージドメイン 上の ディスク の wipe_after_delete のデフォルト値として機能します。

6.240.1. wipe_after_delete
リンクのコピー

この ストレージドメイン 上の ディスク の wipe_after_delete のデフォルト値として機能します。

つまり、新しく作成されたディスクは、デフォルトでストレージドメインから wipe_after_delete 値を取得します。なお、設定値 SANWipeAfterDelete は、ブロックストレージドメインの wipe_after_delete のデフォルト値として機能します。

Expand
表6.315 リンクの概要
Nameタイプ概要

data_center

DataCenter

これは、ストレージドメインがアタッチされているデータセンターにリンクするために使用されます。

data_centers

DataCenter[]

これは、ストレージドメインが接続されているデータセンターへのリンクのセットです。

disk_profiles

DiskProfile[]

 

disk_snapshots

DiskSnapshot[]

 

disks

Disk[]

 

files

File[]

 

host

ホスト

ホストは作成時にのみ関連します。

images

Image[]

 

permissions

Permission[]

 

storage_connections

StorageConnection[]

 

templates

Template[]

 

vms

Vm[]

 

6.241. StorageDomainStatus enum
リンクのコピー

Expand
表6.316 値の概要
Name概要

activating

 

active

 

detaching

 

inactive

 

locked

 

maintenance

 

mixed

 

preparing_for_maintenance

 

unattached

 

unknown

 

6.242. StorageDomainType enum
リンクのコピー

Expand
表6.317 値の概要
Name概要

data

 

export

 

image

 

iso

 

volume

 

6.243. StorageFormat enum
リンクのコピー

Expand
表6.318 値の概要
Name概要

v1

 

v2

 

v3

 

6.244. StorageType enum
リンクのコピー

ストレージドメインのタイプを表すタイプ。

Expand
表6.319 値の概要
Name概要

cinder

Cinder ストレージドメイン。

fcp

Fibre-Channel ストレージドメイン。

glance

Glance ストレージドメイン。

glusterfs

Gluster-FS ストレージドメイン。

iscsi

iSCSI ストレージドメイン。

localfs

ローカルストレージ上のストレージドメイン。

nfs

NFS ストレージドメイン。

posixfs

POSIX-FS ストレージドメイン。

6.244.1. cinder
リンクのコピー

Cinder ストレージドメイン。Cinder の詳細については、Cinder を参照してください。

6.244.2. glance
リンクのコピー

Glance ストレージドメイン。Glance の詳細については、Glance を参照してください。

6.244.3. glusterfs
リンクのコピー

Gluster-FS ストレージドメイン。Gluster の詳細については、Gluster を参照してください。

6.245. SwitchType enum
リンクのコピー

Manager がサポートするすべてのスイッチタイプについて説明します。

Expand
表6.320 値の概要
Name概要

legacy

ネイティブスイッチタイプ。

ovs

Open vSwitch タイプ。

6.246. Tag 構造体
リンクのコピー

システム内のタグを表します。

Expand
表6.321 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.322 リンクの概要
Nameタイプ概要

group

グループ

このタグが割り当てられているグループへの参照。

host

ホスト

このタグが割り当てられているホストへの参照。

parent

タグ

このタグの親タグへの参照。

template

Template

このタグが割り当てられたテンプレートへの参照。

user

User

このタグが割り当てられているユーザーへの参照。

vm

Vm

このタグが割り当てられている仮想マシンへの参照。

6.247. Template 構造体
リンクのコピー

仮想マシンテンプレートを表すタイプ。これにより、共通の設定とディスク状態での仮想マシンの迅速な設定が可能になります。

Expand
表6.323 属性の概要
Nameタイプ概要

bios

Bios

仮想マシンの BIOS 設定への参照。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

console

コンソール

この仮想マシン用に設定されたコンソール。

cpu

Cpu

仮想マシン CPU の設定。

cpu_shares

Integer

 

creation_time

日付

仮想マシンの作成日。

custom_compatibility_version

バージョン

仮想マシンのカスタム互換性バージョン。

custom_cpu_model

String

 

custom_emulated_machine

String

 

custom_properties

CustomProperty[]

さまざまなフックを設定するために VDSM に送信されるプロパティー。

delete_protected

ブール値

true の場合、仮想マシンは削除できません。

description

String

プレーンテキストでの人間が判読できる説明。

display

表示

仮想マシンの表示設定。

domain

Domain

この仮想マシン用に設定されたドメイン。

high_availability

高可用性

仮想マシンの高可用性設定。

id

String

一意の ID

initialization

初期化

仮想マシンの初期化設定への参照。

io

Io

IO スレッドのパフォーマンスチューニング用。

large_icon

アイコン

仮想マシンの大きなアイコン。

memory

Integer

仮想マシンのメモリー (バイト単位)。

memory_policy

MemoryPolicy

仮想マシンのメモリー管理設定への参照。

migration

MigrationOptions

実行中の仮想マシンの別のホストへの移行設定への参照。

migration_downtime

Integer

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

name

String

人間が判読できるプレーンテキストでの名前。

origin

String

この仮想マシンのオリジン。

os

OperatingSystem

仮想マシンにインストールされているオペレーティングシステムのタイプ。

rng_device

RngDevice

この仮想マシンの乱数ジェネレーターデバイスの設定。

serial_number

SerialNumber

クラスター内の仮想マシンのシリアル番号。

small_icon

アイコン

仮想マシンの小さなアイコン。

soundcard_enabled

ブール値

true の場合、サウンドカードが仮想マシンに追加されます。

sso

Sso

この仮想マシンが設定されているシングルサインオン設定への参照。

start_paused

ブール値

true の場合、仮想マシンは起動後、最初は 'paused' 状態になります。

stateless

ブール値

true の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。

status

TemplateStatus

テンプレートのステータス

time_zone

TimeZone

oVirt によって設定された仮想マシンのタイムゾーン。

tunnel_migration

ブール値

true の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。

type

VmType

仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。

usb

Usb

この仮想マシンの USB デバイスの設定 (カウント、タイプ)。

version

TemplateVersion

これが別のテンプレートのベースバージョンかサブバージョンであるかを示します。

virtio_scsi

VirtioScsi

VirtIO SCSI 設定への参照。

vm

Vm

このテンプレートに関連付けられている仮想マシンの設定。

6.247.1. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>
Copy to Clipboard Toggle word wrap

6.247.2. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

仮想マシンを独自の互換性バージョンにカスタマイズできるようにします。custom_compatibility_version が設定されている場合、この特定の仮想マシンのクラスター互換性バージョンをオーバーライドします。

仮想マシンの互換バージョンは、仮想マシンが格納されているデータセンターによって制限され、仮想マシンが実行される予定のホストの機能に対してチェックされます。

6.247.3. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

6.247.4. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.247.5. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>
Copy to Clipboard Toggle word wrap
注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 230 バイト = 1073741824 バイト。

注記

メモリーホットプラグは、Red Hat Virtualization 3.6 以降でサポートされています。上記の例では、仮想マシンの実行中にメモリーを増やすことができます。

6.247.6. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

6.247.7. origin
リンクのコピー

この仮想マシンのオリジン。

値:

  • ovirt
  • rhev
  • vmware
  • xen
  • external
  • hosted_engine
  • managed_hosted_engine
  • kvm
  • physical_machine
  • hyperv

6.247.8. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.247.9. sso
リンクのコピー

この仮想マシンが設定されているシングルサインオン設定への参照。コンソールを開くと、ユーザーは仮想マシンのオペレーティングシステムに自動的にサインインできます。

Expand
表6.324 リンクの概要
Nameタイプ概要

cdroms

Cdrom[]

テンプレートにアタッチされた CD-ROM デバイスへの参照。

cluster

Cluster

仮想マシンが属するクラスターへの参照。

cpu_profile

CpuProfile

この仮想マシンによって使用される CPU プロファイルへの参照。

disk_attachments

DiskAttachment[]

テンプレートに割り当てられたディスクへの参照。

graphics_consoles

GraphicsConsole[]

テンプレートに接続されたグラフィックコンソールへの参照。

nics

Nic[]

テンプレートにアタッチされたネットワークインターフェイスへの参照。

permissions

Permission[]

テンプレートに割り当てられたユーザーパーミッションへの参照。

quota

クォータ

この仮想マシンに設定されたクォータ設定への参照。

storage_domain

StorageDomain

仮想マシンが属するストレージドメインへの参照。

tags

Tag[]

テンプレートにアタッチされたタグへの参照。

watchdogs

Watchdog[]

テンプレートにアタッチされたウォッチドッグデバイスへの参照。

6.248. TemplateStatus enum
リンクのコピー

仮想マシンテンプレートのステータスを表すタイプ。

Expand
表6.325 値の概要
Name概要

illegal

このステータスは、テンプレートの少なくとも 1 つのディスクが不正であることを示します。

locked

このステータスは、テンプレートでの他の操作を妨げる何らかの操作が実行されていることを示します。

ok

このステータスは、テンプレートが有効で使用できる状態であることを示します。

6.249. TemplateVersion 構造体
リンクのコピー

仮想マシンテンプレートのバージョンを表すタイプ。

Expand
表6.326 属性の概要
Nameタイプ概要

version_name

String

このバージョンの名前。

version_number

Integer

テンプレートのバージョン階層におけるこのバージョンのインデックス。

6.249.1. version_number
リンクのコピー

テンプレートのバージョン階層におけるこのバージョンのインデックス。インデックス 1 は、ベースバージョンとも呼ばれるテンプレートの元のバージョンを表します。

Expand
表6.327 リンクの概要
Nameタイプ概要

base_template

Template

このバージョンが関連付けられているテンプレートを参照します。

6.250. Ticket 構造体
リンクのコピー

仮想マシンへのアクセスを許可するチケットを表すタイプ。

Expand
表6.328 属性の概要
Nameタイプ概要

expiry

Integer

チケットの有効期間 (秒単位)。

value

String

仮想マシンのアクセスチケット。

6.251. TimeZone 構造体
リンクのコピー

タイムゾーンの表現。

Expand
表6.329 属性の概要
Nameタイプ概要

name

String

タイムゾーンの名前。

utc_offset

String

https://en からのオフセット。

6.251.1. utc_offset
リンクのコピー

UTC からのオフセット。

6.252. TransparentHugePages 構造体
リンクのコピー

Transparent huge pages (THP) のサポートを表すタイプ。

Expand
表6.330 属性の概要
Nameタイプ概要

enabled

ブール値

THP サポートを有効にします。

6.253. TransportType enum
リンクのコピー

Gluster ボリュームへのアクセスに使用されるプロトコル。

Expand
表6.331 値の概要
Name概要

rdma

Remote direct memory access。

tcp

TCP。

6.254. UnmanagedNetwork 構造体
リンクのコピー

Expand
表6.332 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.333 リンクの概要
Nameタイプ概要

host

ホスト

 

host_nic

HostNic

 

6.255. USB 構造体
リンクのコピー

Expand
表6.334 属性の概要
Nameタイプ概要

enabled

ブール値

 

type

UsbType

 

6.256. UsbType enum
リンクのコピー

Expand
表6.335 値の概要
Name概要

legacy

 

native

 

6.257. User 構造体
リンクのコピー

システム内のユーザーを表します。

Expand
表6.336 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

department

String

 

description

String

プレーンテキストでの人間が判読できる説明。

domain_entry_id

String

 

email

String

 

id

String

一意の ID

last_name

String

 

logged_in

ブール値

 

name

String

人間が判読できるプレーンテキストでの名前。

namespace

String

ユーザーが存在する名前空間。

password

String

 

principal

String

user_name プリンシパルと同じ形式は LDAP プロバイダーによって異なります。

user_name

String

ユーザーのユーザー名。

6.257.1. namespace
リンクのコピー

ユーザーが存在する名前空間。ユーザーを LDAP に保存する認可プロバイダーを使用する場合（詳細は こちら を参照）、この属性は LDAP の命名コンテキストと同じです。ユーザーをデータベースに保存する組み込み認証プロバイダーを使用する場合（詳細は こちら を参照）、この属性は無視されます。

6.257.2. principal
リンクのコピー

user_name プリンシパルと同じ形式は LDAP プロバイダーによって異なります。ほとんどの LDAP プロバイダーの場合、uid LDAP 属性の値です。Active Directory の場合は、ユーザープリンシパル名(UPN)になります。

6.257.3. user_name
リンクのコピー

ユーザーのユーザー名。フォーマットは、認可プロバイダーのタイプによって異なります。ほとんどの LDAP プロバイダーの場合、uid LDAP 属性の値です。Active Directory の場合は、ユーザープリンシパル名(UPN)になります。UPN または uid の後に認証プロバイダー名が続く必要があります。たとえば、uid 属性を使用する LDAP の場合、myuser@myextension-authz になります。UPN を使用する Active Directory の場合、myuser@mysubdomain.mydomain.com@myextension-authz です。この属性は、新規ユーザーを追加する際に必須のパラメーターです。

Expand
表6.337 リンクの概要
Nameタイプ概要

domain

Domain

 

groups

Group[]

 

permissions

Permission[]

 

roles

Role[]

ユーザーリソースのロールサブコレクションへのリンク。

ssh_public_keys

SshPublicKey[]

 

tags

Tag[]

ユーザーリソースのタグサブコレクションへのリンク。

6.258. Value 構造体
リンクのコピー

Expand
表6.338 属性の概要
Nameタイプ概要

datum

10 進数

 

detail

String

 

6.259. ValueType enum
リンクのコピー

Expand
表6.339 値の概要
Name概要

decimal

 

integer

 

string

 

6.260. VcpuPin 構造体
リンクのコピー

Expand
表6.340 属性の概要
Nameタイプ概要

cpu_set

String

 

vcpu

Integer

 

6.261. Vendor 構造体
リンクのコピー

Expand
表6.341 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

6.262. Version 構造体
リンクのコピー

Expand
表6.342 属性の概要
Nameタイプ概要

build

Integer

 

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

full_version

String

 

id

String

一意の ID

major

Integer

 

minor

Integer

 

name

String

人間が判読できるプレーンテキストでの名前。

revision

Integer

 

6.263. VirtioScsi struct
リンクのコピー

virtio-SCSI のサポートを表すタイプ。サポートされている場合は、SCSI ゲストデバイスに virtio ドライバーを使用します。

Expand
表6.343 属性の概要
Nameタイプ概要

enabled

ブール値

Virtio SCSI サポートを有効にします。

6.264. VirtualNumaNode struct
リンクのコピー

仮想 NUMA ノードを表します。

XML 表現の例: 

<vm_numa_node href="/ovirt-engine/api/vms/123/numanodes/456" id="456">
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>1024</memory>
  <numa_node_pins>
    <numa_node_pin>
      <index>0</index>
    </numa_node_pin>
  </numa_node_pins>
  <vm href="/ovirt-engine/api/vms/123" id="123" />
</vm_numa_node>
Copy to Clipboard Toggle word wrap
Expand
表6.344 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

cpu

Cpu

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

index

Integer

 

memory

Integer

NUMA ノードのメモリー (MB)。

name

String

人間が判読できるプレーンテキストでの名前。

node_distance

String

 

numa_node_pins

NumaNodePin[]

 
Expand
表6.345 リンクの概要
Nameタイプ概要

host

ホスト

 

statistics

Statistic[]

 

vm

Vm

 

6.265. Vlan 構造体
リンクのコピー

仮想 LAN (VLAN) タイプを表すタイプ。

Expand
表6.346 属性の概要
Nameタイプ概要

id

Integer

仮想 LAN ID。

6.266. Vm 構造体
リンクのコピー

仮想マシンを表します。

Expand
表6.347 属性の概要
Nameタイプ概要

bios

Bios

仮想マシンの BIOS 設定への参照。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

console

コンソール

この仮想マシン用に設定されたコンソール。

cpu

Cpu

仮想マシン CPU の設定。

cpu_shares

Integer

 

creation_time

日付

仮想マシンの作成日。

custom_compatibility_version

バージョン

仮想マシンのカスタム互換性バージョン。

custom_cpu_model

String

 

custom_emulated_machine

String

 

custom_properties

CustomProperty[]

さまざまなフックを設定するために VDSM に送信されるプロパティー。

delete_protected

ブール値

true の場合、仮想マシンは削除できません。

description

String

プレーンテキストでの人間が判読できる説明。

display

表示

仮想マシンの表示設定。

domain

Domain

この仮想マシン用に設定されたドメイン。

fqdn

String

仮想マシンの完全修飾ドメイン名。

guest_operating_system

GuestOperatingSystem

仮想マシンにインストールされているオペレーティングシステム。

guest_time_zone

TimeZone

仮想マシンが使用するタイムゾーン (ゲストエージェントによって返されます)。

high_availability

高可用性

仮想マシンの高可用性設定。

id

String

一意の ID

initialization

初期化

仮想マシンの初期化設定への参照。

io

Io

IO スレッドのパフォーマンスチューニング用。

large_icon

アイコン

仮想マシンの大きなアイコン。

memory

Integer

仮想マシンのメモリー (バイト単位)。

memory_policy

MemoryPolicy

仮想マシンのメモリー管理設定への参照。

migration

MigrationOptions

実行中の仮想マシンの別のホストへの移行設定への参照。

migration_downtime

Integer

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

name

String

人間が判読できるプレーンテキストでの名前。

next_run_configuration_exists

ブール値

仮想マシンの設定が変更されたため、仮想マシンの再起動が必要です。

numa_tune_mode

NumaTuneMode

NUMA トポロジーの適用方法。

origin

String

この仮想マシンのオリジン。

os

OperatingSystem

仮想マシンにインストールされているオペレーティングシステムのタイプ。

payloads

Payload[]

仮想マシンのオプションのペイロード。ISO が仮想マシンを設定するために使用されます。

placement_policy

VmPlacementPolicy

仮想マシンの配置ポリシーの設定。

rng_device

RngDevice

この仮想マシンの乱数ジェネレーターデバイスの設定。

run_once

ブール値

true の場合、仮想マシンは run once コマンドを使用して開始されています。つまり、この 1 回の実行のために保存されている設定とは異なる可能性があります。

serial_number

SerialNumber

クラスター内の仮想マシンのシリアル番号。

small_icon

アイコン

仮想マシンの小さなアイコン。

soundcard_enabled

ブール値

true の場合、サウンドカードが仮想マシンに追加されます。

sso

Sso

この仮想マシンが設定されているシングルサインオン設定への参照。

start_paused

ブール値

true の場合、仮想マシンは起動後、最初は 'paused' 状態になります。

start_time

日付

仮想マシンが起動された日付。

stateless

ブール値

true の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。

status

VmStatus

仮想マシンの現在の状態

status_detail

String

人間が読める現在のステータスの詳細。

stop_reason

String

仮想マシンが停止した理由。

stop_time

日付

仮想マシンが停止された日付。

time_zone

TimeZone

oVirt によって設定された仮想マシンのタイムゾーン。

tunnel_migration

ブール値

true の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。

type

VmType

仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。

usb

Usb

この仮想マシンの USB デバイスの設定 (カウント、タイプ)。

use_latest_template_version

ブール値

true の場合、仮想マシンは起動時にテンプレートの最新バージョンに再設定されます。

virtio_scsi

VirtioScsi

VirtIO SCSI 設定への参照。

6.266.1. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>
Copy to Clipboard Toggle word wrap

6.266.2. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

仮想マシンを独自の互換性バージョンにカスタマイズできるようにします。custom_compatibility_version が設定されている場合、この特定の仮想マシンのクラスター互換性バージョンをオーバーライドします。

仮想マシンの互換バージョンは、仮想マシンが格納されているデータセンターによって制限され、仮想マシンが実行される予定のホストの機能に対してチェックされます。

6.266.3. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

6.266.4. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.266.5. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>
Copy to Clipboard Toggle word wrap
注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 230 バイト = 1073741824 バイト。

注記

メモリーホットプラグは、Red Hat Virtualization 3.6 以降でサポートされています。上記の例では、仮想マシンの実行中にメモリーを増やすことができます。

6.266.6. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

6.266.7. next_run_configuration_exists
リンクのコピー

仮想マシンの設定が変更されたため、仮想マシンの再起動が必要です。変更された設定は、仮想マシンの シャットダウン 処理時に適用されます。

6.266.8. origin
リンクのコピー

この仮想マシンのオリジン。

値:

  • ovirt
  • rhev
  • vmware
  • xen
  • external
  • hosted_engine
  • managed_hosted_engine
  • kvm
  • physical_machine
  • hyperv

6.266.9. placement_policy
リンクのコピー

仮想マシンの配置ポリシーの設定。

この設定を更新して、仮想マシンを 1 つ以上のホストにピニングできます。

注記

複数のホストにピニングされた仮想マシンはライブマイグレーションできませんが、ホストに障害が発生した場合、高可用性になるように設定された仮想マシンは、仮想マシンがピニングされている他のホストの 1 つで自動的に再起動されます。

たとえば、仮想マシンを 2 つのホストに固定するには、以下のリクエストを送信します。 

PUT /api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>
Copy to Clipboard Toggle word wrap

6.266.10. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.266.11. sso
リンクのコピー

この仮想マシンが設定されているシングルサインオン設定への参照。コンソールを開くと、ユーザーは仮想マシンのオペレーティングシステムに自動的にサインインできます。

6.266.12. stop_reason
リンクのコピー

仮想マシンが停止した理由。オプションで、仮想マシンをシャットダウンするときにユーザーが設定します。

Expand
表6.348 リンクの概要
Nameタイプ概要

affinity_labels

AffinityLabel[]

オプション。

applications

Application[]

仮想マシンにインストールされているアプリケーションのリスト。

cdroms

Cdrom[]

CDROM にマウントされた ISO への参照。

cluster

Cluster

仮想マシンが属するクラスターへの参照。

cpu_profile

CpuProfile

この仮想マシンによって使用される CPU プロファイルへの参照。

disk_attachments

DiskAttachment[]

仮想マシンにアタッチされているディスクへの参照。

external_host_provider

ExternalHostProvider

 

floppies

Floppy[]

フロッピーにマウントされた ISO への参照。

graphics_consoles

GraphicsConsole[]

この仮想マシン用に設定されたグラフィックコンソールのリスト。

host

ホスト

仮想マシンが実行されているホストへの参照。

host_devices

HostDevice[]

この仮想マシンに関連付けられているデバイスへの参照。

instance_type

InstanceType

仮想マシンの設定は、インスタンスタイプの 1 つを介してオプションで事前定義できます。

katello_errata

KatelloErratum[]

仮想マシンに割り当てられたすべての Katello エラータを一覧表示します。

nics

Nic[]

仮想マシン上のネットワークインターフェイスデバイスのリストを参照します。

numa_nodes

NumaNode[]

この仮想マシンで使用される NUMA ノード設定を参照します。

permissions

Permission[]

この仮想マシンに設定されたパーミッション。

quota

クォータ

この仮想マシンに設定されたクォータ設定への参照。

reported_devices

ReportedDevice[]

 

sessions

Session[]

この仮想マシンに対して開かれているユーザーセッションのリスト。

snapshots

Snapshot[]

仮想マシンから取得されたすべてのスナップショットを参照します。

statistics

Statistic[]

この仮想マシンから収集された統計データ。

storage_domain

StorageDomain

仮想マシンが属するストレージドメインへの参照。

tags

Tag[]

 

template

Template

仮想マシンがベースとするテンプレートへの参照。

vm_pool

VmPool

仮想マシンが任意のメンバーであるプールへの参照。

watchdogs

Watchdog[]

ウォッチドッグ設定への参照。

6.267. VmAffinity enum
リンクのコピー

Expand
表6.349 値の概要
Name概要

migratable

 

pinned

 

user_migratable

 

6.268. VmBase 構造体
リンクのコピー

基本的な仮想マシン設定を表します。これは、仮想マシン、テンプレート、およびインスタンスタイプで使用されます。

Expand
表6.350 属性の概要
Nameタイプ概要

bios

Bios

仮想マシンの BIOS 設定への参照。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

console

コンソール

この仮想マシン用に設定されたコンソール。

cpu

Cpu

仮想マシン CPU の設定。

cpu_shares

Integer

 

creation_time

日付

仮想マシンの作成日。

custom_compatibility_version

バージョン

仮想マシンのカスタム互換性バージョン。

custom_cpu_model

String

 

custom_emulated_machine

String

 

custom_properties

CustomProperty[]

さまざまなフックを設定するために VDSM に送信されるプロパティー。

delete_protected

ブール値

true の場合、仮想マシンは削除できません。

description

String

プレーンテキストでの人間が判読できる説明。

display

表示

仮想マシンの表示設定。

domain

Domain

この仮想マシン用に設定されたドメイン。

high_availability

高可用性

仮想マシンの高可用性設定。

id

String

一意の ID

initialization

初期化

仮想マシンの初期化設定への参照。

io

Io

IO スレッドのパフォーマンスチューニング用。

large_icon

アイコン

仮想マシンの大きなアイコン。

memory

Integer

仮想マシンのメモリー (バイト単位)。

memory_policy

MemoryPolicy

仮想マシンのメモリー管理設定への参照。

migration

MigrationOptions

実行中の仮想マシンの別のホストへの移行設定への参照。

migration_downtime

Integer

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

name

String

人間が判読できるプレーンテキストでの名前。

origin

String

この仮想マシンのオリジン。

os

OperatingSystem

仮想マシンにインストールされているオペレーティングシステムのタイプ。

rng_device

RngDevice

この仮想マシンの乱数ジェネレーターデバイスの設定。

serial_number

SerialNumber

クラスター内の仮想マシンのシリアル番号。

small_icon

アイコン

仮想マシンの小さなアイコン。

soundcard_enabled

ブール値

true の場合、サウンドカードが仮想マシンに追加されます。

sso

Sso

この仮想マシンが設定されているシングルサインオン設定への参照。

start_paused

ブール値

true の場合、仮想マシンは起動後、最初は 'paused' 状態になります。

stateless

ブール値

true の場合、仮想マシンはステートレスで、シャットダウン後にその状態 (ディスク) がロールバックされます。

time_zone

TimeZone

oVirt によって設定された仮想マシンのタイムゾーン。

tunnel_migration

ブール値

true の場合、ネットワークデータ転送は仮想マシンのライブマイグレーション中に暗号化されます。

type

VmType

仮想マシンがデスクトップとサーバーのどちらに最適化されているかを決定します。

usb

Usb

この仮想マシンの USB デバイスの設定 (カウント、タイプ)。

virtio_scsi

VirtioScsi

VirtIO SCSI 設定への参照。

6.268.1. cpu
リンクのコピー

仮想マシン CPU の設定。

ソケット設定は、仮想マシンを再起動せずに更新できます。コアとスレッドは再起動する必要があります。

たとえば、ソケットの数をすぐに 4 に変更し、再起動後にコアとスレッドの数を 2 に変更するには、以下のリクエストを送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>
Copy to Clipboard Toggle word wrap

6.268.2. custom_compatibility_version
リンクのコピー

仮想マシンのカスタム互換性バージョン。

仮想マシンを独自の互換性バージョンにカスタマイズできるようにします。custom_compatibility_version が設定されている場合、この特定の仮想マシンのクラスター互換性バージョンをオーバーライドします。

仮想マシンの互換バージョンは、仮想マシンが格納されているデータセンターによって制限され、仮想マシンが実行される予定のホストの機能に対してチェックされます。

6.268.3. high_availability
リンクのコピー

仮想マシンの高可用性設定。設定されている場合、仮想マシンが予期せずダウンしたときに自動的に再起動されます。

6.268.4. large_icon
リンクのコピー

仮想マシンの大きなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.268.5. memory
リンクのコピー

仮想マシンのメモリー (バイト単位)。

たとえば、1 ギビバイト (GiB) のメモリーを含むように仮想マシンを更新するには、次の要求を送信します。 

PUT /ovirt-engine/api/vms/123
Copy to Clipboard Toggle word wrap

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

<vm>
  <memory>1073741824</memory>
</vm>
Copy to Clipboard Toggle word wrap
注記

この例のメモリーは、次の式を使用してバイトに変換されます:
1 GiB = 230 バイト = 1073741824 バイト。

注記

メモリーホットプラグは、Red Hat Virtualization 3.6 以降でサポートされています。上記の例では、仮想マシンの実行中にメモリーを増やすことができます。

6.268.6. migration_downtime
リンクのコピー

別のホストへのライブマイグレーション中に仮想マシンが応答しないでいられる最大時間 (ミリ秒)。

仮想マシンに対して明示的に設定するか、engine-config -s DefaultMaximumMigrationDowntime=[value] で設定します。

6.268.7. origin
リンクのコピー

この仮想マシンのオリジン。

値:

  • ovirt
  • rhev
  • vmware
  • xen
  • external
  • hosted_engine
  • managed_hosted_engine
  • kvm
  • physical_machine
  • hyperv

6.268.8. small_icon
リンクのコピー

仮想マシンの小さなアイコン。ユーザーが設定するか、オペレーティングシステムに従って設定されたイメージを参照します。

6.268.9. sso
リンクのコピー

この仮想マシンが設定されているシングルサインオン設定への参照。コンソールを開くと、ユーザーは仮想マシンのオペレーティングシステムに自動的にサインインできます。

Expand
表6.351 リンクの概要
Nameタイプ概要

cluster

Cluster

仮想マシンが属するクラスターへの参照。

cpu_profile

CpuProfile

この仮想マシンによって使用される CPU プロファイルへの参照。

quota

クォータ

この仮想マシンに設定されたクォータ設定への参照。

storage_domain

StorageDomain

仮想マシンが属するストレージドメインへの参照。

6.269. VmDeviceType enum
リンクのコピー

Expand
表6.352 値の概要
Name概要

cdrom

 

floppy

 

6.270. VmPlacementPolicy 構造体
リンクのコピー

Expand
表6.353 属性の概要
Nameタイプ概要

affinity

VmAffinity

 
Expand
表6.354 リンクの概要
Nameタイプ概要

hosts

Host[]

 

6.271. VmPool 構造体
リンクのコピー

Expand
表6.355 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

display

表示

 

id

String

一意の ID

max_user_vms

Integer

 

name

String

人間が判読できるプレーンテキストでの名前。

prestarted_vms

Integer

 

rng_device

RngDevice

 

size

Integer

 

soundcard_enabled

ブール値

 

stateful

ブール値

仮想マシンプールのステートフルフラグ。

type

VmPoolType

 

use_latest_template_version

ブール値

 

6.271.1. stateful
リンクのコピー

仮想マシンプールのステートフルフラグ。

ステートフル仮想マシンプールの仮想マシンは、常にステートフルモードで起動されます (ステートレススナップショットは作成されません)。仮想マシンが別のユーザーに渡された場合でも、仮想マシンの状態は保持されます。

Expand
表6.356 リンクの概要
Nameタイプ概要

cluster

Cluster

 

instance_type

InstanceType

このプールのベースとなるインスタンスタイプへの参照。

permissions

Permission[]

 

template

Template

 

vm

Vm

 

6.272. VmPoolType enum
リンクのコピー

Expand
表6.357 値の概要
Name概要

automatic

 

manual

 

6.273. VmStatus enum
リンクのコピー

仮想マシンのステータスの represeting と入力します。

Expand
表6.358 値の概要
Name概要

down

このステータスは、仮想マシンプロセスが実行されていないことを示します。

image_locked

このステータスは、仮想マシンプロセスが実行されておらず、仮想マシンのディスクで起動を妨げる操作が行われていることを示します。

migrating

このステータスは、仮想マシンプロセスが実行中であり、仮想マシンがホスト間で移行中であることを示します。

not_responding

このステータスは、仮想マシンが応答していないことをハイパーバイザーが検出したことを示します。

paused

このステータスは、仮想マシンプロセスが実行中であり、仮想マシンが一時停止していることを示します。

powering_down

このステータスは、仮想マシンプロセスが実行中であり、実行を停止しようとしていることを示します。

powering_up

このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムがロードされていることを示します。

reboot_in_progress

このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムが再起動中であることを示します。

restoring_state

このステータスは、仮想マシンプロセスが実行されようとしており、仮想マシンが休止状態から復帰しようとしていることを示します。

saving_state

このステータスは、仮想マシンプロセスが実行中であり、仮想マシンが休止状態にあることを示します。

suspended

このステータスは、仮想マシンプロセスが実行されておらず、仮想マシンの実行状態が保存されたことを示します。

unassigned

このステータスは、無効なステータスを受信したときに設定されます。

unknown

このステータスは、システムが仮想マシンのステータスを特定できなかったことを示します。

up

このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムがロードされていることを示します。

wait_for_launch

このステータスは、仮想マシンプロセスが実行されようとしていることを示します。

6.273.1. paused
リンクのコピー

このステータスは、仮想マシンプロセスが実行中であり、仮想マシンが一時停止していることを示します。これは、仮想マシンが一時停止モードで実行されている場合と、仮想マシンがエラーが原因で自動的に一時停止されている場合の 2 つのケースで発生する可能性があります。

6.273.2. powering_up
リンクのコピー

このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムがロードされていることを示します。ゲストエージェントがインストールされていない場合、このステータスは、仮想マシンの実行時に事前定義された期間 (デフォルトでは 60 秒) に設定されることに注意してください。

6.273.3. restoring_state
リンクのコピー

このステータスは、仮想マシンプロセスが実行されようとしており、仮想マシンが休止状態から復帰しようとしていることを示します。この状態では、仮想マシンの実行状態が復元されています。

6.273.4. saving_state
リンクのコピー

このステータスは、仮想マシンプロセスが実行中であり、仮想マシンが休止状態にあることを示します。この状態では、仮想マシンの実行状態が保存されています。このステータスは、ゲスト OS が休止状態であることを意味するものではないことに注意してください。

6.273.5. suspended
リンクのコピー

このステータスは、仮想マシンプロセスが実行されておらず、仮想マシンの実行状態が保存されたことを示します。このステータスは Down に似ていますが、VM がこのステータスで起動されると、通常の手順を使用して起動される代わりに、保存された実行状態が復元されます。

6.273.6. unknown
リンクのコピー

このステータスは、システムが仮想マシンのステータスを特定できなかったことを示します。このステータスでは、仮想マシンプロセスが実行されているか、実行されていない可能性があります。たとえば、ホストが応答しなくなると、ホストで実行されていた仮想マシンにこのステータスが設定されます。

6.273.7. up
リンクのコピー

このステータスは、仮想マシンプロセスが実行中で、ゲストオペレーティングシステムがロードされていることを示します。ゲストエージェントがインストールされていない場合、このステータスは、仮想マシンの実行時に事前に定義された期間 (デフォルトでは 60 秒) 後に設定されることに注意してください。

6.273.8. wait_for_launch
リンクのコピー

このステータスは、仮想マシンプロセスが実行されようとしていることを示します。このステータスは、仮想マシンを実行する要求がホストに到着したときに設定されます。仮想マシンプロセスの実行に失敗する可能性があります。

6.274. VmSummary 構造体
リンクのコピー

Expand
表6.359 属性の概要
Nameタイプ概要

active

Integer

 

migrating

Integer

 

total

Integer

 

6.275. VmType enum
リンクのコピー

仮想マシンの最適化対象を表す型。

Expand
表6.360 値の概要
Name概要

desktop

仮想マシンは、デスクトップとして使用することを目的としています。

server

仮想マシンは、サーバーとして使用することを目的としています。

6.275.1. desktop
リンクのコピー

仮想マシンは、デスクトップとして使用することを目的としています。現在、サウンドデバイスが仮想マシンに自動的に追加されることを意味します。

6.275.2. server
リンクのコピー

仮想マシンは、サーバーとして使用することを目的としています。現時点では、サウンドデバイスが仮想マシンに自動的に追加されないことを意味します。

6.276. VnicPassThrough 構造体
リンクのコピー

Expand
表6.361 属性の概要
Nameタイプ概要

mode

VnicPassThroughMode

vNIC を仮想デバイスとして実装するか、ホストデバイスへのパススルーとして実装するかを定義します。

6.277. VnicPassThroughMode enum
リンクのコピー

列挙は、パススルーデバイスまたは仮想デバイスとして実装される vNIC を記述します。現在、2 つのオプションのみをサポートしますが、今後さらに追加される予定です。

Expand
表6.362 値の概要
Name概要

disabled

仮想デバイスとして実装

enabled

パススルーデバイスとして実装される

6.278. VnicProfile 構造体
リンクのコピー

Expand
表6.363 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

custom_properties

CustomProperty[]

 

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

pass_through

VnicPassThrough

 

port_mirroring

ブール値

 
Expand
表6.364 リンクの概要
Nameタイプ概要

network

ネットワーク

 

network_filter

NetworkFilter

ネットワークフィルターは、参加した仮想マシンとの間でネットワークパケットトラフィックを管理する管理者機能を強化します。

permissions

Permission[]

 

qos

Qos

 

6.279. VolumeGroup struct
リンクのコピー

Expand
表6.365 属性の概要
Nameタイプ概要

id

String

 

logical_units

LogicalUnit[]

 

name

String

 

6.280. Watchdog 構造体
リンクのコピー

このタイプは、ウォッチドッグ設定を表します。

Expand
表6.366 属性の概要
Nameタイプ概要

action

WatchdogAction

ウォッチドッグがトリガーされたときに実行されるウォッチドッグアクション。

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

id

String

一意の ID

model

WatchdogModel

ウォッチドッグデバイスのモデル。

name

String

人間が判読できるプレーンテキストでの名前。

6.280.1. model
リンクのコピー

ウォッチドッグデバイスのモデル。現在、I6300ESB のみがサポートされています。

Expand
表6.367 リンクの概要
Nameタイプ概要

instance_type

InstanceType

オプションで、デバイスが使用するインスタンスタイプへの参照。

template

Template

オプションで、デバイスが使用するテンプレートへの参照。

vm

Vm

この要素は使用せず、代わりに vms を使用してください。

vms

Vm[]

このデバイスを使用する仮想マシンへの参照。

6.281. WatchdogAction enum
リンクのコピー

このタイプは、利用可能なウォッチドッグアクションを記述します。

Expand
表6.368 値の概要
Name概要

dump

仮想マシンプロセスは、ホストのデフォルトパスにコアダンプされます。

none

ウォッチドッグアクションがトリガーされる場合、アクションは実行されません。

pause

ウォッチドッグアクションがトリガーされると、仮想マシンは一時停止します。

poweroff

ウォッチドッグアクションがトリガーされると、仮想マシンの電源がオフになります。

reset

ウォッチドッグアクションがトリガーされると、仮想マシンが再起動されます。

6.281.1. none
リンクのコピー

ウォッチドッグアクションがトリガーされる場合、アクションは実行されません。ただし、ログメッセージは引き続き生成されます。

6.282. WatchdogModel enum
リンクのコピー

このタイプはウォッチドッグモデルを表します。

Expand
表6.369 値の概要
Name概要

i6300esb

現在サポートされるモデルのみがモデル I6300ESB です。

6.283. Weight 構造体
リンクのコピー

Expand
表6.370 属性の概要
Nameタイプ概要

comment

String

このオブジェクトに関するコメントを含むフリーテキスト。

description

String

プレーンテキストでの人間が判読できる説明。

factor

Integer

 

id

String

一意の ID

name

String

人間が判読できるプレーンテキストでの名前。

Expand
表6.371 リンクの概要
Nameタイプ概要

scheduling_policy

SchedulingPolicy

 

scheduling_policy_unit

SchedulingPolicyUnit

 

付録A プリミティブ型
リンクのコピー

このセクションでは、API でサポートされているプリミティブデータ型について説明します。

A.1. 文字列 プリミティブ
リンクのコピー

Unicode 文字の有限シーケンス。

A.2. ブール値 プリミティブ
リンクのコピー

数理論理学で使用される false の概念と true の概念を表します。

有効な値は文字列 false と true です。

エンジンは大文字と小文字を区別しないため、たとえば False と FALSE はどちらも有効な値です。ただし、サーバーは常に小文字の値を返します。

古いバージョンのエンジンとの後方互換性のために、値 0 と 1 も使用できます。値 0 は false を、1 は true を意味します。これらの値のサポートは今後削除される可能性があるため、これらの値の使用は避けてください。

A.3. 整数 プリミティブ
リンクのコピー

整数の数学的概念を表します。

有効な値は、10 進数の有限シーケンスです。

現在，エンジンはこの型を符号付き 32 ビット整数で実装しており，最小値は 231 (-2147483648) で、最大値は 231-1 (2147483647) となっています。

ただし、システムには、32 ビットで可能な値の範囲では不十分な属性がいくつかあります。これらの例外的なケースでは、エンジンは、特に次の属性に対して 64 ビット整数を使用します。

  • Disk.actual_size
  • Disk.provisioned_size
  • GlusterClient.bytes_read
  • GlusterClient.bytes_written
  • Host.max_scheduling_memory
  • Host.memory
  • HostNic.speed
  • LogicalUnit.size
  • MemoryPolicy.guaranteed
  • NumaNode.memory
  • QuotaStorageLimit.limit
  • StorageDomain.available
  • StorageDomain.used
  • StorageDomain.committed
  • VmBase.memory

これらの例外の場合、最小値は -263 (-9223372036854775808) で、最大値は 263-1 (9223372036854775807) です。

注記

今後、整数型は無制限の精度の整数を使用して実装されるため、上記の制限と例外は最終的にはなくなります。

A.4. 10 進 プリミティブ型
リンクのコピー

実数の数学的概念を表します。

現在、エンジンは 32 ビット IEEE 754 シングル精度浮動小数点数を使用してこのタイプを実装します。

一部の属性では、この精度では十分ではありません。これらの例外的なケースでは、エンジンは 64 ビットの倍精度浮動小数点数を、特に次の属性に使用します。

  • QuotaStorageLimit.usage
  • QuotaStorageLimit.memory_limit
  • QuotaStorageLimit.memory_usage
注記

今後、10 進数型は無制限の精度の 10 進数を使用して実装されるため、上記の制限と例外は最終的にはなくなります。

A.5. Date プリミティブ
リンクのコピー

日付と時刻を表します。

エンジンによって返される形式は、XML を要求するときに XML スキーマ仕様 に記述されている形式です。たとえば、次のようなリクエストを送信して、仮想マシンの XML 表現を取得するとします。 

GET /ovirt-engine/api/vms/123
Accept: application/xml
Copy to Clipboard Toggle word wrap

応答本文には、次の XML ドキュメントが含まれます。 

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <creation_time>2016-09-08T09:53:35.138+02:00</creation_time>
  ...
</vm>
Copy to Clipboard Toggle word wrap

JSON 表現を要求する場合、エンジンは別の形式を使用します。1970 年 1月 1 日からの秒数を含む整数。これは エポック時間 としても知られています。たとえば、次のようなリクエストを送信して、仮想マシンの JSON 表現を取得するとします。 

GET /ovirt-engine/api/vms/123
Accept: application/json
Copy to Clipboard Toggle word wrap

応答本文には、次の JSON ドキュメントが含まれます。 

{
  "id": "123",
  "href="/ovirt-engine/api/vms/123",
  ...
  "creation_time": 1472564909990,
  ...
}
Copy to Clipboard Toggle word wrap
注記

いずれの場合も、エンジンによって返される日付は、実行中のサーバーで設定されたタイムゾーンを使用します。上記の例では UTC+2 になります。

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat