...

REST API ガイド - Red Hat Customer Portal

by user

on
Category: Documents
168

views

Report

Comments

Transcript

REST API ガイド - Red Hat Customer Portal
Red Hat Enterprise Virtualization 3.6
REST API ガイド
Red Hat Enterprise Virtualization REST アプリケーションプログラミング
インターフェースの使用
Red Hat Enterprise Virtualization Documentation Team
Red Hat Enterprise Virtualization 3.6 REST API ガイド
Red Hat Enterprise Virtualization REST アプリケーションプログラミング
インターフェースの使用
Red Hat Enterprise Virtualizatio n Do cumentatio n Team
Red Hat Custo mer Co ntent Services
rhev-do [email protected] m
法律上の通知
Co pyright © 20 16 Red Hat.
This do cument is licensed by Red Hat under the Creative Co mmo ns Attributio n-ShareAlike 3.0
Unpo rted License. If yo u distribute this do cument, o r a mo dified versio n o f it, yo u must pro vide
attributio n to Red Hat, Inc. and pro vide a link to the o riginal. If the do cument is mo dified, all Red
Hat trademarks must be remo ved.
Red Hat, as the licenso r o f this do cument, waives the right to enfo rce, and agrees no t to assert,
Sectio n 4 d o f CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shado wman lo go , JBo ss, MetaMatrix, Fedo ra, the Infinity
Lo go , and RHCE are trademarks o f Red Hat, Inc., registered in the United States and o ther
co untries.
Linux ® is the registered trademark o f Linus To rvalds in the United States and o ther co untries.
Java ® is a registered trademark o f Oracle and/o r its affiliates.
XFS ® is a trademark o f Silico n Graphics Internatio nal Co rp. o r its subsidiaries in the United
States and/o r o ther co untries.
MySQL ® is a registered trademark o f MySQL AB in the United States, the Euro pean Unio n and
o ther co untries.
No de.js ® is an o fficial trademark o f Jo yent. Red Hat So ftware Co llectio ns is no t fo rmally
related to o r endo rsed by the o fficial Jo yent No de.js o pen so urce o r co mmercial pro ject.
The OpenStack ® Wo rd Mark and OpenStack Lo go are either registered trademarks/service
marks o r trademarks/service marks o f the OpenStack Fo undatio n, in the United States and o ther
co untries and are used with the OpenStack Fo undatio n's permissio n. We are no t affiliated with,
endo rsed o r spo nso red by the OpenStack Fo undatio n, o r the OpenStack co mmunity.
All o ther trademarks are the pro perty o f their respective o wners.
概要
本ガイドは、Red Hat Enterprise Virtualizatio n の Representatio nal State Transfer (REST) API に
ついて説明します。
目次
目次
. . 1. 章
⁠第
. . はじめに
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5. . . . . . . . . .
⁠1.1. Rep res entatio nal State Trans fer
5
⁠1.2. Red Hat Enterp ris e Virtualiz atio n REST API の前提条件
5
. . 2. 章
⁠第
. . 認証とセキュリティー
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7. . . . . . . . . .
⁠2 .1. TLS/SSL 証明書
7
⁠2 .2. HTTP 認証
8
⁠2 .3. 認証セッション
9
. . 3章
⁠第
. . . REST
. . . . . .API
. . . クイックスタートの例
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1. 1. . . . . . . . . .
⁠3 .1. 例: API エントリーポイントへのアクセス
11
⁠3 .2. 例: データセンターコレクションの一覧表示
13
⁠3 .3. 例: ホストクラスターコレクションの一覧表示
14
⁠3 .4. 例: 論理ネットワークコレクションの一覧表示
15
⁠3 .5. 例: ホストコレクションの一覧表示
16
⁠3 .6 . 例: CPU プロファイルの一覧表示
18
⁠3 .7. 例: ホストの承認
20
⁠3 .8 . 例: NFS データストレージの作成
20
⁠3 .9 . 例: NFS ISO ストレージの作成
⁠3 .10 . 例: データセンターへのストレージドメインのアタッチ
⁠3 .11. 例: ストレージドメインのアクティブ化
22
23
24
⁠3 .12. 例: 仮想マシンの作成
⁠3 .13. 例: 仮想マシン NIC の作成
25
29
⁠3 .14. 例: 仮想マシン用ストレージディスクの作成
⁠3 .15. 例: 仮想マシンへの ISO イメージのアタッチ
29
30
⁠3 .16 . 例: 仮想マシンの起動
⁠3 .17. 例: システムイベントのチェック
31
32
. . 4. 章
⁠第
. . エントリーポイント
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
...........
⁠4 .1. 製品情報
⁠4 .2. リンクの要素
35
35
⁠4 .3. 特殊オブジェクトの要素
⁠4 .4. サマリーの要素
37
37
⁠4 .5. RESTful Servic e Des c rip tio n Lang uag e (RSDL)
⁠4 .6 . Red Hat Enterp ris e Virtualiz atio n Wind o ws ゲストの VSS サポート
⁠4 .7. Q EMU ゲストエージェントの概要
⁠4 .8 . VSS トランザクションフロー
37
39
39
40
. . 5章
⁠第
. . . 互換性レベルのバージョン
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. 1. . . . . . . . . .
⁠5 .1. 互換性レベルのアップグレード
41
. . 6. 章
⁠第
. . 機能
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4. 3. . . . . . . . . .
⁠6 .1. バージョン依存の機能
43
⁠6 .2. 現行バージョン
43
⁠6 .3. 機能
44
. . 7. 章
⁠第
. . 共通の機能
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. 7. . . . . . . . . .
⁠7 .1. 要素のプロパティーを表すアイコン
⁠7 .2. 表現
⁠7 .3. コレクション
⁠7 .4. リソース
47
47
48
54
. . 8. 章
⁠第
. . バックアップ
. . . . . . . . . . ./リストア
. . . . . . . .API
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6. 0. . . . . . . . . .
⁠8 .1. 仮想マシンのバックアップ
60
1
REST API ガイド
⁠8 .1. 仮想マシンのバックアップ
⁠8 .2. 仮想マシンの復元
60
61
. . 9. 章
⁠第
. . データセンター
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6. 3. . . . . . . . . .
⁠9 .1. データセンターの要素
63
⁠9 .2. データセンターの XML 表現
64
⁠9 .3. データセンターの JSO N 表現
⁠9 .4. メソッド
⁠9 .5. サブコレクション
⁠9 .6 . アクション
64
65
66
71
. . 1. 0. 章
⁠第
. . .クラスター
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7. 3. . . . . . . . . .
⁠10 .1. クラスターの要素
73
⁠10 .2.
⁠10 .3.
⁠10 .4.
⁠10 .5.
memo ry_p o lic y 要素
スケジューリングポリシーの要素
クラスターの XML 表現
クラスターの JSO N 表現
⁠10 .6 . メソッド
⁠10 .7. サブコレクション
74
75
75
76
78
79
. . 1. 1. 章
⁠第
. . .ネットワーク
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8. 8. . . . . . . . . .
⁠11.1. ネットワークの要素
⁠11.2. ネットワークリソースの XML 表現
88
88
⁠11.3. ネットワークリソースの JSO N 表現
⁠11.4. メソッド
89
90
⁠11.5. サブコレクション
91
. . 1. 2. 章
⁠第
. . .ストレージドメイン
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9. 3. . . . . . . . . .
⁠12.1. ストレージドメインの要素
⁠12.2. ストレージドメインの XML 表現
93
94
⁠12.3. ストレージドメインの JSO N 表現
⁠12.4. メソッド
95
96
⁠12.5. ストレージタイプ
97
⁠12.6 . エクスポートストレージドメイン
⁠12.7. G lanc e イメージストレージドメイン
99
10 2
⁠12.8 . サブコレクション
10 3
⁠12.9 . アクション
10 4
. . 1. 3章
⁠第
. . . ストレージ接続
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.0. 7. . . . . . . . . .
⁠13.1. ストレージ接続の要素
10 7
⁠13.2. ストレージ接続リソースの XML 表現
⁠13.3. メソッド
10 8
10 8
. . 1. 4. 章
⁠第
. . .ホスト
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.1. 2. . . . . . . . . .
⁠14.1. ホストの要素
112
⁠14.2. ホストの XML 表現
⁠14.3. ホストの JSO N 表現
114
117
⁠14.4. 電源管理の要素
⁠14.5. メモリー管理の要素
120
122
⁠14.6 . メソッド
123
⁠14.7. サブコレクション
⁠14.8 . アクション
124
141
. . 1. 5章
⁠第
. . . 仮想マシン
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.4. 7. . . . . . . . . .
2
⁠15.1. 仮想マシンの要素
147
⁠15.2. 仮想マシンの XML 表現
152
目次
⁠15.2. 仮想マシンの XML 表現
⁠15.3. 仮想マシンの追加 O VF データの XML 表現
152
154
⁠15.4. 仮想マシンの JSO N 表現
⁠15.5. メソッド
156
16 0
⁠15.6 . サブコレクション
16 3
⁠15.7. アクション
18 8
. . 1. 6. 章
⁠第
. . .フローティングディスク
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.9. 7. . . . . . . . . .
⁠16 .1. フローティングディスクの要素
19 7
⁠16 .2. フローティングディスクの XML 表現
⁠16 .3. メソッド
19 8
19 9
⁠16 .4. サブコレクション
19 9
⁠16 .5. アクション
20 1
. . 1. 7. 章
⁠第
. . .テンプレート
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.0. 2. . . . . . . . . .
⁠17.1. 仮想マシンテンプレートの要素
20 2
⁠17.2. 仮想マシンのテンプレートの XML 表現
20 4
⁠17.3. メソッド
⁠17.4. アクション
20 5
20 7
. . 1. 8. 章
⁠第
. . .仮想マシンのプール
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.0. 8. . . . . . . . . .
⁠18 .1. 仮想マシンプールの要素
⁠18 .2. 仮想マシンプールの XML 表現
20 8
20 8
⁠18 .3. メソッド
20 9
⁠18 .4. アクション
210
. . 1. 9. 章
⁠第
. . .ドメイン
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.1. 1. . . . . . . . . .
⁠19 .1. ドメインの要素
211
⁠19 .2. ドメインリソースの XML 表現
⁠19 .3. サブコレクション
211
211
. . 2. 0. 章
⁠第
. . .グループ
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. 1. 3. . . . . . . . . .
⁠2 0 .1. インポートしたグループの要素
213
⁠2 0 .2. グループリソースの XML 表現
⁠2 0 .3. ディレクトリーサービスからのグループの追加
213
213
. . 2. 1. 章
⁠第
. . .ロール
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. 1. 5. . . . . . . . . .
⁠2 1.1. ロールの要素
215
⁠2 1.2. ロールコレクションの XML 表現
215
⁠2 1.3. メソッド
⁠2 1.4. ロールの p ermits のサブコレクション
216
217
. . 2. 2. 章
⁠第
. . .ユーザー
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.1. 9. . . . . . . . . .
⁠2 2.1. ユーザーの要素
219
⁠2 2.2. ユーザーリソースの XML 表現
219
⁠2 2.3. メソッド
220
. . 2. 3章
⁠第
. . . タグ
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.2. 2. . . . . . . . . .
⁠2 3.1. タグの要素
⁠2 3.2. タグリソースの XML 表現
222
222
⁠2 3.3. タグの関連付け
222
⁠2 3.4. 親タグ
224
. . 2. 4. 章
⁠第
. . .イベント
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.2. 7. . . . . . . . . .
⁠2 4.1. イベントの要素
227
⁠2 4.2. イベントコレクションの XML 表現
⁠2 4.3. 仮想マシン作成イベントの XML 表現
227
228
3
REST API ガイド
⁠2 4.3. 仮想マシン作成イベントの XML 表現
228
⁠2 4.4. メソッド
228
. .録
⁠付
. .A. cURL
. . . . . .での
. . . .API
. . .の使用法
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. 32
...........
⁠A .1. c URL での API の使用法
232
⁠A .2. c URL のインストール
232
⁠A .3. c URL の使用法
232
⁠A .4. 例
233
. .録
⁠付
. .B. .列挙値の変換
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. 36
...........
⁠B .1. 列挙値の変換
236
. .録
⁠付
. .C. イベントコード
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. 37
...........
⁠C .1. イベントコード
237
. .録
⁠付
. .D. .タイムゾーン
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
. . 6. . . . . . . . . .
⁠D .1. タイムゾーン
316
. .録
⁠付
. .E. 改訂履歴
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
. . 9. . . . . . . . . .
4
⁠第1 章 はじめに
第1章 はじめに
Red Hat Enterprise Virtualization Manager は R ep resen t at io n al St at e T ran sf er ( R EST ) API を提
供しています。API により、ソフトウェア開発者やシステム管理者は、標準の Web インターフェースを使
用せずに Red Hat Enterprise Virtualization 環境を管理することができます。REST API は、開発者や管理
者が Red Hat Enterprise Virtualization 環境の機能にカスタムスクリプトや標準の Hypertext Transfer
Protocol (HTTP) を介して API にアクセスする外部アプリケーションを統合する場合に役立ちます。
REST API には、以下のようなメリットがあります。
幅広いクライアントサポート: HTTP 対応のあらゆるプログラミング言語/フレームワーク/システムで使
用することが可能
自己記述型: 詳しい情報の多くは実行時に確認できるため、クライアントアプリケーションに必要な仮想
化インフラストラクチャーの知識は最小限で済む
リソースベースのモデル: リソースベースの REST モデルにより仮想化プラットフォームを自然な形で
管理することが可能
これにより、開発者および管理者は以下のような作業を行うことができます。
エンタープライズ IT システムとの統合
サードパーティーの仮想ソフトウェアとの統合
自動メンテナンスやエラーチェックなどのタスクの実行
スクリプトによる Red Hat Enterprise Virtualization 環境内の反復タスクの自動化
本ガイドは、Red Hat Enterprise Virtualization Manager REST API の参考資料としてご利用ください。開
発者および管理者を対象に、直接 REST API から、または提供されている Python ライブラリーを使用して
Red Hat Enterprise Virtualization 環境の機能を十分にご活用いただくための手順および実例を記載してい
ます。
1.1. Represent at ional St at e T ransfer
R ep resen t at io n al St at e T ran sf er ( R EST ) は、特定のサービスとそれらの表現にフォーカスした設
計アーキテクチャーです。リソース表現は、サーバー上にある 1 つの特定管理対象要素に対応した情報の主
要な抽象概念です。クライアントは Uniform Resource Identifier (URI) にあるサーバー要素に対して要求を
送信し、G ET 、P O ST 、P UT 、D ELET E などの標準的な HTTP メソッドで操作を実行します。これによ
り、クライアントとサーバー間のステートレスな通信が提供され、各要求は他の要求に依存せずに機能し、
その要求を完了するために必要な情報をすべて含みます。
1.2. Red Hat Ent erprise Virt ualiz at ion REST API の前提条件
R ed H at En t erp rise Virt u aliz at io n R EST API の前提条件
ネットワーク接続された Red Hat Enterprise Virtualization Manager のインストール (REST API を含
む)
REST API からの HTTP 要求を開始および受信するクライアントまたはプログラミングライブラリー。
以下に例を示します。
Python ソフトウェア開発キット (SD K)
Java ソフトウェア開発キット (SD K)
5
REST API ガイド
cU R L コマンドラインツール
R EST C lien t (RESTful Web サービスのデバッガー)
REST API の対話に使用する HTTP (Hypertext Transfer Protocol) についての知識。Hypertext
Transfer Protocol についての説明は Internet Engineering Task Force 提供の RFC (Request for
Comments) に記載されています (http://www.ietf.org/rfc/rfc2616.txt)。
API がリソース表現の構築に使用する Extensible Markup Language (XML) または JavaScript Object
Notation (JSON) に関する知識。完全な XML 仕様は、W3C のサイト http://www.w3.org/TR/xml/ に掲
載されています。また、ECMA International が http://www.ecma-international.org で JSON に関する
ドキュメントを無料で提供しています。
6
⁠第2 章 認証とセキュリティー
第2章 認証とセキュリティー
2.1. T LS/SSL 証明書
Red Hat Enterprise Virtualization Manager API で、Manager の SD K や CLI コンポーネントなどのクラ
イアントソフトウェアとセキュアな対話を行うには、Hypertext Transfer Protocol Secure (HTTPS) ⁠ [1]
が必要です。これには、Red Hat Enterprise Virtualization Manager から証明書を取得してクライアント
の証明書ストアにインポートするプロセスが伴います。
重要
セキュアなネットワーク接続を使用して Red Hat Enterprise Virtualization Manager から証明書を
取得します。
手順2.1 証明書の取得
以下の 3 つのメソッドのいずれかを使用して、Red Hat Enterprise Virtualization Manager から証明書を
取得してクライアントマシンに転送することができます。
1. メソッド 1: コマンドラインツールを使用して Manager から証明書をダウンロードします。コマン
ドラインツールには、cU R L や Wg et などがあり、いずれも複数のプラットフォームで使用可能で
す。
a. cU R L の使用例
$ curl -o rhevm.cer http://[rhevm-server]/ca.crt
b. Wg et の使用例
$ wget -O rhevm.cer http://[rhevm-server]/ca.crt
2. メソッド 2: Web ブラウザーを使用して、証明書がある場所に移動します。
http://[rhevm-server]/ca.crt
選択したブラウザーによって、証明書がダウンロードされる場合と、ブラウザーのキーストアにイ
ンポートされる場合とがあります。
a. ブラウザーが証明書をダウンロードする場合には、そのファイルを rhevm. cer という名
前で保存します。
ブラウザーが証明書をインポートする場合には、ブラウザーの証明書オプションでその証
明書をエクスポートし、rhevm. cer という名前で保存します。
3. メソッド 3: Manager にログインしてトラストストアから証明書をエクスポートして、クライアン
トマシンにコピーします。
a. Manager に ro o t ユーザーとしてログインします。
b. Java keyt o o l 管理ユーティリティーを使用して、トラストストアから証明書をエクス
ポートします。
7
REST API ガイド
$ keytool -exportcert -keystore /etc/pki/ovirtengine/.truststore -alias cacert -storepass mypass -file
rhevm.cer
rhevm. cer という名前の証明書ファイルが作成されます。
c. scp コマンドを使用して、証明書をクライアントマシンにコピーします。
$ scp rhevm.cer [username]@ [client-machine]:[directory]
上記のいずれの方法を実行した場合も、クライアントマシンには rhevm. cer という名前の証明書ファイル
が作成されます。API ユーザーにより、このファイルがクライアントの証明書ストアにインポートされま
す。
手順2.2 クライアントへの証明書のインポート
クライアントへの証明書インポートの方法は、クライアント自体が証明書をどのように格納し、解釈す
るかによって異なります。本ガイドには、証明書のインポートの例をいくつか記載しています。
Network Security Services (NSS) または Java keystore (JKS) を使用しないクライアントでの証明書
インポートに関する詳細情報は、そのクライアントのマニュアルを参照してください。
2.2. HT T P 認証
Red Hat Enterprise Virtualization アカウントを持つユーザーは、REST API にアクセスできます。API
ユーザーは、API を対象とする全要求において、必須の Red Hat Enterprise Virtualization Manager ユー
ザー名とパスワードを送信します。各要求は HTTP 基本認証 ⁠ [2] を使用してこれらの認証情報をエンコー
ドします。要求に適切な Autho ri zati o n ヘッダーが記載されていない場合には、API は 4 0 1
Autho ri zati o n R eq ui red を送信します。
例2.1 適切な認証情報なしの R EST API へのアクセス
HEAD [base] HTTP/1.1
Host: [host]
HTTP/1.1 401 Authorization Required
要求は、指定したレルムに対して Autho ri zati o n ヘッダー付きで発行されます。API ユーザー
は、username@ d o mai n: passwo rd の形式で提供される認証情報内の適切な Red Hat Enterprise
Virtualization Manager ドメインおよびユーザーをエンコードします。
以下の表には、認証情報を base64 でエンコードするプロセスをまとめています。
表2.1 API アクセス用の認証情報のエンコード
項目
値
ユーザー名
ドメイン
パスワード
エンコードされていない認証
情報
rhevmadmin
domain.example.com
123456
[email protected]:123456
8
⁠第2 章 認証とセキュリティー
項目
値
base64 エンコードされた認 cmhldm1hZ G1pbkBibGFjay5xdW1yYW5ldC5jb206MTIzND U2
証情報
API ユーザーは、base64 でエンコードされた認証情報を以下のように提供します。
例2.2 適切な認証情報を使用した R EST API へのアクセス
HEAD [base] HTTP/1.1
Host: [host]
Authorization: Basic cmhldm1hZG1pbkBibGFjay5xdW1yYW5ldC5jb206MTIzNDU2
HTTP/1.1 200 OK
...
重要
基本認証では、パスワードなどの潜在的な機密情報がプレーンテキストで送信されてしまいます。
REST API には、プレーンテキストの要求をトランスポートレベルで暗号化する Hypertext Transfer
Protocol Secure (HTTPS) が必要です。
重要
base64 ライブラリーによっては、結果を複数行に分け、行末には改行文字を付けることがありま
す。そのような場合には、ヘッダーが破損し、要求に問題が発生します。認証ヘッダーには、エン
コードされた認証情報がヘッダー内に一行で記載されている必要があります。
2.3. 認証セッション
API は、認証セッションサポートの機能も提供します。API ユーザーが認証情報とともに最初の要求を送信
すると、それ以降に送信する要求はすべて、セッション cookie を使用して認証することができます。以下
の手順は、認証済みセッションを使用する方法を示しています。
手順2.3 認証済みセッションの要求
1. Autho ri zati o n および P refer: persi stent-auth を使用して要求を送信します。
HEAD [base] HTTP/1.1
Host: [host]
Authorization: Basic
cmhldm1hZG1pbkBibGFjay5xdW1yYW5ldC5jb206MTIzNDU2
Prefer: persistent-auth
HTTP/1.1 200 OK
...
これにより、次のヘッダーの応答が返されます。
9
REST API ガイド
Set-Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK; Path=/api; Secure
JSESSIO NID = 値を確認してください。上記の例では、この値は
JSESSIO NID = 5d Q ja5ubr4 yvI2MM2z+ LZxrK です。
2. 以降の要求にはすべて P refer: persi stent-auth ヘッダーと JSESSIO NID = 値を指定した
co o ki e ヘッダーを使用して送信します。認証済みセッションを使用することによ
り、Autho ri zati o n が必要なくなります。
HEAD [base] HTTP/1.1
Host: [host]
Prefer: persistent-auth
cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK
HTTP/1.1 200 OK
...
3. セッションが必要なくなった場合は、P refer: persi stent-auth ヘッダーなしでサーバーへ
の要求を実行します。
HEAD [base] HTTP/1.1
Host: [host]
Authorization: Basic
cmhldm1hZG1pbkBibGFjay5xdW1yYW5ldC5jb206MTIzNDU2
HTTP/1.1 200 OK
...
[1] HTTPS についての説明は RFC 28 18 HTTP O ver TLS を参照してください。
[2] 基本認証については、RFC 26 17 HTTP Authentic atio n: Bas ic and Dig es t Ac c es s Authentic atio n に記載さ
れている説明を参照してください。
10
⁠第3章 REST API クイックスタートの例
第3章 REST API クイックスタートの例
本章では、基本的な Red Hat Enterprise Virtualization 環境をセットアップし、仮想マシンを作成する
REST API の機能の例を示します。
以下の例には、通常の標準的な前提条件に加えて、次の項目が必要となります。
Red Hat Enterprise Virtualization Hypervisor をインストールした、ネットワーク接続/設定済みのホス
ト。
仮想マシンにインストールする任意のオペレーティングシステムを格納した ISO ファイル。本章では、
インストール ISO の例に Red Hat Enterprise Linux Server 6 を使用しています。
選択したオペレーティングシステム ISO ファイルを更新する Red Hat Enterprise Virtualization の
en g in e- iso - u p lo ad er ツール。
以下の例では、cU R L を使用して、クライアントアプリケーションによる REST 要求について具体的に説
明します。HTTP 要求に対応したアプリケーションはいずれも cU R L の代わりに使用できる点に注意して
ください。
重要
以下の例では、記載内容をわかりやすくするために、HTTP 要求ヘッダーの Ho st: と
Autho ri zati o n: のフィールドを省略していますが、これらのフィールドは必須フィールドであ
り、ご使用の Red Hat Enterprise Virtualization Manager インストール固有のデータを記載する必
要があります。
重要
cU R L の例にはすべて、認証情報 (USER : P ASS) と証明書の場所 (C ER T ) 用のプレースホルダーが
含まれています。cU R L を使用して実行する要求がすべて証明および認証の要件を満たしているこ
とを確認してください。
注記
Red Hat Enterprise Virtualization Manager は、各リソースの i d 属性用にグローバル一意識別子
(GUID ) を生成します。以下の例に記載の識別子コードは、ご使用の Red Hat Enterprise
Virtualization 環境の識別子コードとは異なる場合があります。
3.1. 例: API エントリーポイントへのアクセス
以下の要求は、API の主要エントリーポイントの表現を取得します。
例3.1 API エントリーポイントへのアクセス
要求:
11
REST API ガイド
GET /api HTTP/1.1
Accept: application/xml
cU R L コマンド:
# curl -X GET -H "Accept: application/xml" -u [USER:PASS] \
--cacert [CERT] https://[RHEVM Host]:443/api
結果:
HTTP/1.1 200 OK
Content-Type: application/xml
<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}"/>
<special_objects>
<link rel="templates/blank"
href="/api/templates/00000000-0000-0000-0000-000000000000"/>
<link rel="tags/root"
href="/api/tags/00000000-0000-0000-0000-000000000000"/>
</special_objects>
<product_info>
<name>Red Hat Enterprise Virtualization</name>
<vendor>Red Hat</vendor>
<version revision="0" build="0" minor="0" major="3"/>
</product_info>
<summary>
<vms>
<total>5</total>
<active>0</active>
12
⁠第3章 REST API クイックスタートの例
</vms>
<hosts>
<total>1</total>
<active>1</active>
</hosts>
<users>
<total>1</total>
<active>1</active>
</users>
<storage_domains>
<total>2</total>
<active>2</active>
</storage_domains>
</summary>
</api>
エントリーポイントは、仮想化環境内のコレクションへのリンクをユーザーに提供します。各コレクション
リンクの rel = 属性は、各リンクの参照ポイントを提供します。この例の次のステップで
は、rel = "d atacenter" リンクで入手可能な d atacenter コレクションについて考察します。
エントリーポイントには pro d uct_i nfo 、speci al _o bjects、summary などのその他のデータも含
まれます。このようなデータについては別の章で説明しています。
3.2. 例: データセンターコレクションの一覧表示
Red Hat Enterprise Virtualization Manager は、インストール時に D efaul t データセンターを作成しま
す。以下の例では D efaul t データセンターを仮想化環境の基盤として使用します。
以下の要求は、データセンターコレクションの表現を取得します。
例3.2 データセンターコレクションの一覧表示
要求:
GET /api/datacenters HTTP/1.1
Accept: application/xml
cU R L コマンド:
# curl -X GET -H "Accept: application/xml" -u [USER:PASS] \
--cacert [CERT] \
https://[RHEVM Host]:443/api/datacenters
結果:
HTTP/1.1 200 OK
Content-Type: application/xml
<data_centers>
<data_center href="/api/datacenters/00000002-0002-0002-00020000000003ab" id="00000002-0002-0002-0002-0000000003ab">
<name>Default</name>
13
REST API ガイド
<description>The default Data Center</description>
<link rel="storagedomains"/>
href="/api/datacenters/00000002-0002-0002-00020000000003ab/storagedomains"
<link rel="clusters"/>
href="/api/datacenters/00000002-0002-0002-00020000000003ab/clusters"
<link rel="networks"/>
href="/api/datacenters/00000002-0002-0002-00020000000003ab/networks"
<link rel="permissions"/>
href="/api/datacenters/00000002-0002-0002-00020000000003ab/permissions"
<link rel="quotas"/>
href="/api/datacenters/00000002-0002-0002-00020000000003ab/quotas"
<link rel="iscsibonds"/>
href="/api/datacenters/00000002-0002-0002-00020000000003ab/iscsibonds"
<link rel="qoss"/>
href="/api/datacenters/00000002-0002-0002-00020000000003ab/qoss"
<local>false</local>
<storage_format>v3</storage_format>
<version major="3" minor="5"/>
<supported_versions>
<version major="3" minor="5"/>
</supported_versions>
<status>
<state>up</state>
</status>
</data_center>
</data_centers>
D efaul t データセンターの i d コードに注意してください。このコードは、仮想化環境のその他のリソー
スに関連付けて、このデータセンターを特定します。
データセンターには sto rag ed o mai ns サブコレクションへのリンクも含まれます。データセンターは、
このサブコレクションを使用して sto rag ed o mai ns メインコレクションからストレージドメインをア
タッチします。これについては本章の後半で説明します。
3.3. 例: ホストクラスターコレクションの一覧表示
Red Hat Enterprise Virtualization Manage は、インストール時に D efaul t のホストクラスターを作成し
ます。以下の例は D efaul t クラスターを使用して Red Hat Enterprise Virtualization 環境内のリソースを
グループ化します。
以下の要求は、クラスターコレクションの表現を取得します。
例3.3 ホストクラスターコレクションの一覧表示
要求:
14
⁠第3章 REST API クイックスタートの例
GET /api/clusters HTTP/1.1
Accept: application/xml
cU R L コマンド:
# curl -X GET -H "Accept: application/xml" -u [USER:PASS] \
--cacert [CERT] \
https://[RHEVM Host]:443/api/clusters
結果:
HTTP/1.1 200 OK
Content-Type: application/xml
<clusters>
<cluster id="99408929-82cf-4dc7-a532-9d998063fa95"
href="/api/clusters/99408929-82cf-4dc7-a532-9d998063fa95">
<name>Default</name>
<description>The default server cluster</description>
<link rel="networks"
href="/api/clusters/99408929-82cf-4dc7-a5329d998063fa95/networks"/>
<link rel="permissions"
href="/api/clusters/99408929-82cf-4dc7-a5329d998063fa95/permissions"/>
<cpu id="Intel Penryn Family"/>
<data_center id="01a45ff0-915a-11e0-8b87-5254004ac988"
href="/api/datacenters/01a45ff0-915a-11e0-8b875254004ac988"/>
<memory_policy>
<overcommit percent="100"/>
<transparent_hugepages>
<enabled>false</enabled>
</transparent_hugepages>
</memory_policy>
<scheduling_policy/>
<version minor="0" major="3"/>
<error_handling>
<on_error>migrate</on_error>
</error_handling>
</cluster>
</clusters>
D efaul t ホストクラスターの i d コードに注意してください。このコードは、仮想化環境のその他のリ
ソースに関連付けて、このホストクラスターを特定します。
D efaul t クラスターは、d ata_center 要素の i d 属性と href 属性を使用したリレーションシップによ
り D efaul t データセンターに関連付けられます。
netwo rks のサブコレクションには、このクラスターの関連付けられたネットワークリソース一覧が含ま
れます。次のセクションでは netwo rks のコレクションについて詳細に考察します。
3.4 . 例: 論理ネットワークコレクションの一覧表示
15
REST API ガイド
Red Hat Enterprise Virtualization Manager は、インストール時にデフォルトの o vi rtmg mt ネットワー
クを作成します。このネットワークは、Red Hat Enterprise Virtualization Manager が Hypervisor ホスト
にアクセスするための管理ネットワークとして機能します。
このネットワークは D efaul t クラスターに関連付けられた、D efaul t データセンターのメンバーとなり
ます。以下の例では、仮想マシンへの接続に o vi rtmg mt ネットワークを使用しています。
以下の要求は、論理ネットワークコレクションの表現を取得します。
例3.4 論理ネットワークコレクションの一覧表示
要求:
GET /api/networks HTTP/1.1
Accept: application/xml
cU R L コマンド:
# curl -X GET -H "Accept: application/xml" -u [USER:PASS] \
--cacert [CERT] \
https://[RHEVM Host]:443/api/networks
結果:
HTTP/1.1 200 OK
Content-Type: application/xml
<networks>
<network id="00000000-0000-0000-0000-000000000009"
href="/api/networks/00000000-0000-0000-0000-000000000009">
<name>ovirtmgmt</name>
<description>Management Network</description>
<data_center id="01a45ff0-915a-11e0-8b87-5254004ac988"
href="/api/datacenters/01a45ff0-915a-11e0-8b875254004ac988"/>
<stp>false</stp>
<status>
<state>operational</state>
</status>
<display>false</display>
</network>
</networks>
o vi rtmg mt ネットワークは、データセンターの i d コードを使用したリレーションシップにより
D efaul t データセンターにアタッチされます。
o vi rtmg mt ネットワークは、クラスターの netwo rk サブコレクション内のリレーションシップによっ
ても、D efaul t クラスターにアタッチされます。
3.5. 例: ホストコレクションの一覧表示
16
⁠第3章 REST API クイックスタートの例
以下の例では、Red Hat Enterprise Virtualization Hypervisor ホストを使用しています。Red Hat
Enterprise Virtualization Manager は、設定済みの Red Hat Enterprise Virtualization Hypervisor を自動
的に登録します。この例は、ホストコレクションの表現を取得し、仮想化環境に登録されている
hypervi so r という名前の Red Hat Enterprise Virtualization Hypervisor ホストを表示します。
例3.5 ホストコレクションの一覧表示
要求:
GET /api/hosts HTTP/1.1
Accept: application/xml
cU R L コマンド:
# curl -X GET -H "Accept: application/xml" -u [USER:PASS] \
--cacert [CERT] \
https://[RHEVM Host]:443/api/hosts
結果:
HTTP/1.1 200 OK
Accept: application/xml
<hosts>
<host id="0656f432-923a-11e0-ad20-5254004ac988"
href="/api/hosts/0656f432-923a-11e0-ad20-5254004ac988">
<name>hypervisor</name>
<actions>
<link rel="install"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/install"/>
<link rel="activate"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/activate"/>
<link rel="fence"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/fence"/>
<link rel="deactivate"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/deactivate"/>
<link rel="approve"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/approve"/>
<link rel="iscsilogin"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/iscsilogin"/>
<link rel="iscsidiscover"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/iscsidiscover"/>
<link rel="commitnetconfig"
href="/api/hosts/0656f432-923a-11e0-ad20-5254004ac988/
commitnetconfig"/>
</actions>
17
REST API ガイド
<link rel="storage"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/storage"/>
<link rel="nics"
href="/api/hosts/0656f432-923a-11e0-ad20-5254004ac988/nics"/>
<link rel="tags"
href="/api/hosts/0656f432-923a-11e0-ad20-5254004ac988/tags"/>
<link rel="permissions"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/permissions"/>
<link rel="statistics"
href="/api/hosts/0656f432-923a-11e0-ad205254004ac988/statistics"/>
<address>10.64.14.110</address>
<status>
<state>non_operational</state>
</status>
<cluster id="99408929-82cf-4dc7-a532-9d998063fa95"
href="/api/clusters/99408929-82cf-4dc7-a532-9d998063fa95"/>
<port>54321</port>
<storage_manager>true</storage_manager>
<power_management>
<enabled>false</enabled>
<options/>
</power_management>
<ksm>
<enabled>false</enabled>
</ksm>
<transparent_hugepages>
<enabled>true</enabled>
</transparent_hugepages>
<iscsi>
<initiator>iqn.199405.com.example:644949fe81ce</initiator>
</iscsi>
<cpu>
<topology cores="2"/>
<name>Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz</name>
<speed>2993</speed>
</cpu>
<summary>
<active>0</active>
<migrating>0</migrating>
<total>0</total>
</summary>
</host>
</hosts>
D efaul t ホストの i d コードに注意してください。このコードは、仮想化環境のその他のリソースに関連
付けてこのホストを特定します。
このホストは、D efaul t のメンバーで、ni cs サブコレクションにアクセスすると、このホストが
o vi rtmg mt ネットワークに接続されていることが表示されます。
3.6. 例: CPU プロファイルの一覧表示
18
⁠第3章 REST API クイックスタートの例
以下の要求は、CPU プロファイルの表現を取得します。
例3.6 C PU プロファイルの一覧表示
要求:
GET /api/cpuprofiles HTTP/1.1
Accept: application/xml
cU R L コマンド:
# curl -X GET -H "Accept: application/xml" -u [USER:PASS] --cacert
[CERT] https://[RHEVM Host]:443/api/cpuprofiles
結果:
HTTP/1.1 200 OK
Content-Type: application/xml
<cpu_profiles>
<cpu_profile href="0000001a-001a-001a-001a-00000000035e"
id="0000001a-001a-001a-001a-00000000035e">
<name>Default</name>
<link href="/api/cpuprofiles/0000001a-001a-001a-001a00000000035e/permissions" rel="permissions"/>
<cluster href= "/api/clusters/00000001-0001-0001-000100000000021b" id="00000001-0001-0001-0001-00000000021b"/>
</cpu_profile>
<cpu_profile href="fc4b9188-f87f-44f9-b9c5-c7665e10e0a2"
id="fc4b9188-f87f-44f9-b9c5-c7665e10e0a2">
<name>Premium</name>
<description>Full service available</description>
<link href="/api/cpuprofiles/fc4b9188-f87f-44f9-b9c5c7665e10e0a2/permissions" rel="permissions"/>
<qos href= "/api/datacenters/00000002-0002-0002-00020000000000f7/qoss/5afe49e3-aac4-4b7b-bb83-11b9aef285e1" id="5afe49e3aac4-4b7b-bb83-11b9aef285e1"/>
<cluster href= "/api/clusters/00000001-0001-0001-000100000000021b" id="00000001-0001-0001-0001-00000000021b"/>
</cpu_profile>
<cpu_profile href="48c600f4-6768-49ca-9c16-a877d0e586e5"
id="48c600f4-6768-49ca-9c16-a877d0e586e5">
<name>Budget</name>
<description>Limited CPU</description>
<link href="/api/cpuprofiles/48c600f4-6768-49ca-9c16a877d0e586e5/permissions" rel="permissions"/>
<cluster href= "/api/clusters/00000001-0001-0001-000100000000021b" id="00000001-0001-0001-0001-00000000021b"/>
</cpu_profile>
<cpu_profile href="48c600f4-6768-49ca-9c16-a877d0e586e5"
id="48c600f4-6768-49ca-9c16-a877d0e586e5">
<name>Backup</name>
19
REST API ガイド
<link href="/api/cpuprofiles/d510b042-42f0-4cb2-9d2e25fcc28d6c5f/permissions" rel="permissions"/>
<cluster href= "/api/clusters/668cab0c-9185-4eaa-9942658284eeecdd" id="668cab0c-9185-4eaa-9942-658284eeecdd"/>
</cpu_profile>
</cpu_profiles>
3.7. 例: ホストの承認
hypervi so r ホストリソースには、appro ve のアクションが含まれます。ユーザーは P O ST 要求を使用
して、このアクションの URI にアクセスします。
例3.7 事前設定済みの R ed H at En t erp rise Virt u aliz at io n H yp erviso r ホストの承認
要求:
POST /api/hosts/0656f432-923a-11e0-ad20-5254004ac988/approve HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<action/>" \
https://[RHEVM Host]:443/api/hosts/0656f432-923a-11e0-ad205254004ac988/approve
POST 要求には、アクションを開始するためのメッセージエンティティーの本文が必要です。アクション
には、追加のパラメーターは必要ないため、本文には空の acti o n 要素が記載されます。
appro ve アクションは、Red Hat Enterprise Virtualization Hypervisor ホスト以外には使用しないでくだ
さい。Red Hat Enterprise Linux ホストの場合は、仮想化環境への接続に異なるプロセスが必要となりま
す。
これにより仮想化環境でのホストの使用が承認されアクティブ化されます。hypervi so r の status が
no n_o perati o nal から up に変わります。
3.8. 例: NFS データストレージの作成
NFS データストレージドメインは、エクスポートされた NFS 共有です。データセンターにアタッチされ、
仮想化ゲストのイメージを格納するストレージを提供します。新規ストレージドメインを作成するに
は、P O ST 要求にストレージドメインの表現を記載し、ストレージドメインコレクションの URL に送信す
る必要があります。
20
⁠第3章 REST API クイックスタートの例
Red Hat Enterprise Virtualization 3.6 以降では、ストレージドメインの削除後にワイプのオプションをデ
フォルトで有効にすることができます。この設定は、P O ST 要求で <wi pe_after_d el ete> を指定しま
す。このオプションは、ドメインの作成後に編集することが可能ですが、その場合にはすでに存在していた
ディスクの「削除後にワイプ」プロパティーは変更されません。
例3.8 N FS データストレージドメインの作成
要求:
POST /api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_domain>
<name>data1</name>
<type>data</type>
<storage>
<type>nfs</type>
<address>192.168.0.10</address>
<path>/data1</path>
</storage>
<host>
<name>hypervisor</name>
</host>
</storage_domain>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<storage_domain><name>data1</name><type>data</type> \
<storage><type>nfs</type><address>192.168.0.10</address> \
<path>/data1</path></storage> \
<host><name>hypervisor</name></host></storage_domain>" \
https://[RHEVM Host]:443/api/storagedomains
API は、19 2. 16 8. 0 . 10 : /d ata1 のエクスポートパスで d ata1 という名前の NFS データストレー
ジドメインを作成し、hypervi so r ホスト経由のストレージドメインへのアクセスを設定します。ま
た、API は新たに作成したストレージドメインリソースの表現を以下のように返します。
結果:
HTTP/1.1 200 OK
Accept: application/xml
<storage_domain id="9ca7cb40-9a2a-4513-acef-dc254af57aac"
href="/api/storagedomains/9ca7cb40-9a2a-4513-acef-dc254af57aac">
<name>data1</name>
<link rel="permissions"
href="/api/storagedomains/9ca7cb40-9a2a-4513-acef-dc254af57aac/
permissions"/>
<link rel="files"
href="/api/storagedomains/9ca7cb40-9a2a-4513-acef-
21
REST API ガイド
dc254af57aac/files"/>
<type>data</type>
<master>false</master>
<storage>
<type>nfs</type>
<address>192.168.0.10</address>
<path>/data1</path>
</storage>
<available>175019917312</available>
<used>27917287424</used>
<committed>10737418240</committed>
<storage_format>v1</storage_format>
<host id="0656f432-923a-11e0-ad20-5254004ac988"
href="/api/hosts/0656f432-923a-11e0-ad20-5254004ac988">
</storage_domain>
3.9. 例: NFS ISO ストレージの作成
NFS ISO ストレージドメインは、データセンターにアタッチされたマウント済みの NFS 共有です。
D VD /CD -ROM の ISO および仮想フロッピーディスク (VFD ) などのイメージファイル用のストレージを提
供します。新規ストレージドメインを作成するには、ストレージドメインの表現を記載した P O ST 要求を
ストレージドメインコレクションの URL に送信する必要があります。
Red Hat Enterprise Virtualization 3.6 以降では、ストレージドメインの削除後にワイプのオプションをデ
フォルトで有効にすることができます。この設定は、P O ST 要求で <wi pe_after_d el ete> を指定しま
す。このオプションは、ドメインの作成後に編集することが可能ですが、その場合にはすでに存在していた
ディスクの「削除後にワイプ」プロパティーは変更されません。
例3.9 N FS ISO ストレージドメインの作成
要求:
POST /api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_domain>
<name>iso1</name>
<type>iso</type>
<storage>
<type>nfs</type>
<address>192.168.0.10</address>
<path>/iso1</path>
</storage>
<host>
<name>hypervisor</name>
</host>
</storage_domain>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
22
⁠第3章 REST API クイックスタートの例
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<storage_domain><name>iso1</name><type>iso</type> \
<storage><type>nfs</type><address>192.168.0.10</address> \
<path>/iso1</path></storage> \
<host><name>hypervisor</name></host></storage_domain>" \
https://[RHEVM Host]:443/api/storagedomains
API は、エクスポートパスが 19 2. 16 8. 0 . 10 : /i so 1 の i so 1 という名前の NFS iso ストレージド
メインを作成し、hypervi so r ホスト経由でストレージドメインにアクセスします。また、API は新た
に作成したストレージドメインリソースの表現を以下のように返します。
結果:
HTTP/1.1 200 OK
Accept: application/xml
<storage_domain id="00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da">
<name>iso1</name>
<link rel="permissions"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da/
permissions"/>
<link rel="files"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e3c898fa8b6da/files"/>
<type>iso</type>
<host id="" href="">
<master>false</master>
<storage>
<type>nfs</type>
<address>192.168.0.10</address>
<path>/iso1</path>
</storage>
<available>82678120448</available>
<used>18253611008</used>
<committed>0</committed>
<storage_format>v1</storage_format>
<host id="0656f432-923a-11e0-ad20-5254004ac988"
href="/api/hosts/0656f432-923a-11e0-ad20-5254004ac988">
</storage_domain>
3.10. 例: データセンターへのストレージドメインのアタッチ
以下の例は、d ata1 と i so 1 のストレージドメインを D efaul t データセンターにアタッチします。
例3.10 D ef au lt データセンターへの d at a1 ストレージドメインのアタッチ
要求:
POST /api/datacenters/01a45ff0-915a-11e0-8b875254004ac988/storagedomains HTTP/1.1
23
REST API ガイド
Accept: application/xml
Content-type: application/xml
<storage_domain>
<name>data1</name>
</storage_domain>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<storage_domain><name>data1</name></storage_domain>" \
https://[RHEVM Host]:443/api/datacenters/01a45ff0-915a-11e0-8b875254004ac988/storagedomains
例3.11 D ef au lt データセンターへの iso 1 ストレージドメインのアタッチ
要求:
POST /api/datacenters/01a45ff0-915a-11e0-8b875254004ac988/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_domain>
<name>iso1</name>
</storage_domain>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<storage_domain><name>iso1</name></storage_domain>" \
https://[RHEVM Host]:443/api/datacenters/01a45ff0-915a-11e0-8b875254004ac988/storagedomains
上記の P O ST 要求は、新規作成された 2 つの sto rag e_d o mai n リソースを D efaul t データセンター
の sto rag ed o mai ns サブコレクション内に配置します。これは、sto rag ed o mai ns サブコレクショ
ンにアタッチされたデータセンターストレージドメインが含まれることを意味します。
3.11. 例: ストレージドメインのアクティブ化
以下の例は、Red Hat Enterprise Virtualization Manager で使用するために、d ata1 と i so 1 の各スト
レージドメインをアクティブ化します。
例3.12 d at a1 ストレージドメインのアクティブ化
要求:
24
⁠第3章 REST API クイックスタートの例
POST /api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/
9ca7cb40-9a2a-4513-acef-dc254af57aac/activate HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<action/>" \
https://[RHEVM Host]:443/api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/9ca7cb40-9a2a-4513-acefdc254af57aac/activate
例3.13 iso 1 ストレージドメインのアクティブ化
要求:
POST /api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/
00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da/activate HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<action/>"
https://[RHEVM Host]:443/api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/00f0d9ce-da15-4b9e-9e3e3c898fa8b6da/activate
これにより、両ストレージドメインがアクティブ化され、データセンターに使用できるようになります。
3.12. 例: 仮想マシンの作成
以下の例では、仮想化環境の Bl ank テンプレートをベースとして使用し、D efaul t クラスター上に vm1
という名前の仮想マシンを作成します。また、この要求は、仮想マシンの memo ry を 512 MB に定義
し、bo o t デバイスを仮想ハードディスクに設定します。
例3.14 仮想マシンの作成
25
REST API ガイド
要求:
POST /api/vms HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<name>vm1</name>
<cluster>
<name>default</name>
</cluster>
<template>
<name>Blank</name>
</template>
<memory>536870912</memory>
<os>
<boot dev="hd"/>
</os>
<cpu_profile id="0000001a-001a-001a-001a-00000000035e"/>
</vm>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" -u [USER:PASS] --cacert [CERT] -d "<vm>
<name>vm1</name><cluster><name>default</name></cluster><template>
<name>Blank</name></template><memory>536870912</memory><os><boot
dev='hd'/></os><cpu_profile id='0000001a-001a-001a-001a-00000000035e'/>
</vm>" https://[RHEVM Host]:443/api/vms
結果
HTTP/1.1 200 OK
Accept: application/xml
<vm id="6efc0cfa-8495-4a96-93e5-ee490328cf48"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48">
<name>vm1</name>
<actions>
<link rel="shutdown"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/shutdown"/>
<link rel="start"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/start"/>
<link rel="stop"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/stop"/>
<link rel="reboot"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/reboot"/>
<link rel="suspend"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/suspend"/>
<link rel="detach"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/detach"/>
<link rel="export"
26
⁠第3章 REST API クイックスタートの例
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/export"/>
<link rel="move"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/move"/>
<link rel="ticket"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/ticket"/>
<link rel="migrate"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/migrate"/>
<link rel="undo_snapshot"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/undo_snapshot"/>
<link rel="commit_snapshot"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/commit_snapshot"/>
<link rel="preview_snapshot"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/preview_snapshot"/>
<link rel="logon"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/logon"/>
<link rel="cancelmigration"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/cancelmigration"/>
<link rel="maintenance"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/maintenance"/>
<link rel="clone"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/clone"/>
</actions>
<link rel="applications"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/applications"/>
<link rel="disks"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/disks"/>
<link rel="nics"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/nics"/>
<link rel="cdroms"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/cdroms"/>
<link rel="snapshots"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/snapshots"/>
<link rel="tags"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/tags"/>
<link rel="permissions"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/permissions"/>
<link rel="statistics"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/statistics"/>
<link rel="reporteddevices"
href="/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/reporteddevices"/>
<link rel="watchdogs"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/watchdogs"/>
<link rel="sessions"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/sessions"/>
<type>desktop</type>
<status>
<state>down</state>
27
REST API ガイド
</status>
<memory>536870912</memory>
<cpu>
<topology cores="1" sockets="1"/>
</cpu>
<os type="Unassigned">
<boot dev="cdrom"/>
</os>
<high_availability>
<enabled>false</enabled>
<priority>0</priority>
</high_availability>
<display>
<type>spice</type>
<monitors>1</monitors>
<single_qxl_pci>false</single_qxl_pci>
<allow_override>false</allow_override>
<smartcard_enabled>false</smartcard_enabled>
<file_transfer_enabled>true</file_transfer_enabled>
<copy_paste_enabled>true</copy_paste_enabled>
</display>
<cluster id="99408929-82cf-4dc7-a532-9d998063fa95"
href="/api/clusters/99408929-82cf-4dc7-a532-9d998063fa95"/>
<template id="00000000-0000-0000-0000-000000000000"
href="/api/templates/00000000-0000-0000-0000-000000000000"/>
<stop_time>2011-06-15T04:48:02.167Z</stop_time>
<creation_time>2011-06-15T14:48:02.078+10:00</creation_time>
<origin>rhev</origin>
<stateless>false</stateless>
<delete_protected>false</delete_protected>
<sso>
<methods>
<method id="GUEST_AGENT"/>
</methods>
</sso>
<console enabled="false"/>
<timezone>Etc/GMT</timezone>
<initialization>
<configuration>
<type>ovf</type>
<data>...</data>
</configuration>
</initialization>
<placement_policy>
<affinity>migratable</affinity>
</placement_policy>
<memory_policy>
<guaranteed>536870912</guaranteed>
<ballooning>true</ballooning>
</memory_policy>
<usb>
<enabled>false</enabled>
</usb>
<soundcard_enabled>true</soundcard_enabled>
<migration_downtime>-1</migration_downtime>
<virtio_scsi enabled="true"/>
28
⁠第3章 REST API クイックスタートの例
<cpu_profile id="0000001a-001a-001a-001a-00000000035e"/>
<next_run_configuration_exists>false</next_run_configuration_exists>
<numa_tune_mode>interleave</numa_tune_mode>
</vm>
3.13. 例: 仮想マシン NIC の作成
以下の例では、仮想ネットワークインターフェースを作成して、サンプルの仮想マシンを o vi rtmg mt
ネットワークに接続します。
例3.15 仮想マシン N IC の作成
要求:
POST /api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/nics HTTP/1.1
Accept: application/xml
Content-type: application/xml
<nic>
<interface>virtio</interface>
<name>nic1</name>
<network>
<name>ovirtmgmt</name>
</network>
</nic>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<nic><name>nic1</name><network><name>ovirtmgmt</name>
</network></nic>" \
https://[RHEVM Host]:443/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/nics
3.14 . 例: 仮想マシン用ストレージディスクの作成
以下の例では、サンプルの仮想マシン用に 8 GB の Copy On Write のストレージディスクを作成します。
例3.16 仮想マシン用ストレージディスクの作成
要求:
POST /api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/disks HTTP/1.1
Accept: application/xml
Content-type: application/xml
29
REST API ガイド
<disk>
<storage_domains>
<storage_domain id="9ca7cb40-9a2a-4513-acef-dc254af57aac"/>
</storage_domains>
<size>8589934592</size>
<type>system</type>
<interface>virtio</interface>
<format>cow</format>
<bootable>true</bootable>
</disk>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<disk><storage_domains> \
<storage_domain id='9ca7cb40-9a2a-4513-acef-dc254af57aac'/> \
</storage_domains><size>8589934592</size><type>system</type> \
<interface>virtio</interface><format>cow</format> \
<bootable>true</bootable></disk>" \
https://[RHEVM Host]:443/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/disks
sto rag e_d o mai n 要素は、d ata1 ストレージドメインにディスクを保存するよう API に指示します。
3.15. 例: 仮想マシンへの ISO イメージのアタッチ
サンプルの仮想マシンのブートメディアには、オペレーティングシステムインストール用 CD -ROM または
D VD の ISO イメージが必要です。以下の例では、Red Hat Enterprise Server 6 の ISO を使用していま
す。
仮想マシンが ISO イメージを使用できるようするには、その ISO イメージが i so 1 ISO ドメインで使用可
能である必要があります。Red Hat Enterprise Virtualization プラットフォームは、ISO イメージを適切な
ユーザー権限で適切なディレクトリーパスにアップロードするためのアップローダーツールを提供していま
す。
ISO のアップロードが完了したら、API ユーザーは ISO ストレージドメインの fi l es サブコレクション
を要求してファイルリソースを表示します。
例3.17 ISO ストレージドメイン内の f iles サブコレクションの表示
要求:
GET /api/storagedomains/00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da/files
HTTP/1.1
Accept: application/xml
cU R L コマンド:
30
⁠第3章 REST API クイックスタートの例
# curl -X GET -H "Accept: application/xml" -u [USER:PASS] --cacert
[CERT] \
https://[RHEVM Host]:443/api/storagedomains/00f0d9ce-da15-4b9e9e3e-3c898fa8b6da/files
API は、files サブコレクションの表現を以下のように返します。
<files>
<file id="rhel-server-6.0-x86_64-dvd.iso"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da/
files/rhel-server-6.0-x86_64-dvd.iso.iso">
<name>rhel-server-6.0-x86_64-dvd.iso.iso</name>
<storage_domain id="00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e3c898fa8b6da"/>
</file>
</files>
API ユーザーは、rhel -server-6 . 0 -x86 _6 4 -d vd . i so をサンプルの仮想マシンにアタッチします。
ISO イメージのアタッチは、管理ポータルまたはユーザーポータルで C D /D VD を変更 を使用するのと同
じです。
例3.18 仮想マシンへの ISO イメージのアタッチ
要求:
POST /api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/cdroms HTTP/1.1
Accept: application/xml
Content-type: application/xml
<cdrom>
<file id="rhel-server-6.0-x86_64-dvd.iso"/>
</cdrom>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<cdrom><file id='rhel-server-6.0-x86_64-dvd.iso'/></cdrom>" \
https://[RHEVM Host]:443/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/cdroms
3.16. 例: 仮想マシンの起動
仮想化環境が完成し、仮想マシンが機能するために必要なコンポーネントがすべて実装されたところで、次
の例では、start アクションを使用して仮想マシンを起動します。
例3.19 仮想マシンの起動
31
REST API ガイド
要求:
POST /api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48/start HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<vm>
<os>
<boot dev="cdrom"/>
</os>
</vm>
</action>
cU R L コマンド:
# curl -X POST -H "Accept: application/xml" -H "Content-Type:
application/xml" \
-u [USER:PASS] --cacert [CERT] \
-d "<action><vm><os><boot dev='cdrom'/></os></vm></action>" \
https://[RHEVM Host]:443/api/vms/6efc0cfa-8495-4a96-93e5ee490328cf48/start
追加のメッセージエンティティーは、今回のブートでのみ、仮想マシンの起動デバイスを CD -ROM に設定
しています。これにより仮想マシンは、アタッチされた ISO イメージから Red Hat Enterprise Server 6 を
インストールできるようになります。それ以降の起動では、ブートデバイスは d i sk に戻ります。
3.17. 例: システムイベントのチェック
vm1 の start アクションは events コレクション内に複数のエントリーを作成します。以下の例は、イベ
ントコレクションを一覧表示し、仮想マシンを起動している API 固有のイベントを特定します。
例3.20 イベントコレクションの一覧表示
要求:
GET /api/events HTTP/1.1
Accept: application/xml
cU R L コマンド:
# curl -X GET -H "Accept: application/xml" -u [USER:PASS] \
--cacert [CERT] \
https://[RHEVM Host]:443/api/events
結果:
<events>
...
<event id="103" href="/api/events/103">
32
⁠第3章 REST API クイックスタートの例
<description>User admin logged out.</description>
<code>31</code>
<severity>normal</severity>
<time>2011-06-29T17:42:41.544+10:00</time>
<user id="80b71bae-98a1-11e0-8f20-525400866c73"
href="/api/users/80b71bae-98a1-11e0-8f20-525400866c73"/>
</event>
<event id="102" href="/api/events/102">
<description>vm1 was started by admin (Host: hypervisor).
</description>
<code>153</code>
<severity>normal</severity>
<time>2011-06-29T17:42:41.499+10:00</time>
<user id="80b71bae-98a1-11e0-8f20-525400866c73"
href="/api/users/80b71bae-98a1-11e0-8f20-525400866c73"/>
<vm id="6efc0cfa-8495-4a96-93e5-ee490328cf48"
href="/api/vms/6efc0cfa-8495-4a96-93e5-ee490328cf48"/>
<host id="0656f432-923a-11e0-ad20-5254004ac988"
href="/api/hosts/0656f432-923a-11e0-ad20-5254004ac988"/>
</event>
<event id="101" href="/api/events/101">
<description>User admin logged in.</description>
<code>30</code>
<severity>normal</severity>
<time>2011-06-29T17:42:40.505+10:00</time>
<user id="80b71bae-98a1-11e0-8f20-525400866c73"
href="/api/users/80b71bae-98a1-11e0-8f20-525400866c73"/>
</event>
...
</events>
以下のイベントが発生します。
i d = "10 1": API は ad mi n ユーザーのユーザー名とパスワードで認証を行います。
i d = "10 2": API は ad mi n ユーザーとして、hypervi so r ホストで vm1 を起動します。
i d = "10 3": API は ad mi n ユーザーアカウントからログアウトします。
33
REST API ガイド
第4章 エントリーポイント
ホスト と ベース で構成されるエントリーポイント URI に対してG ET 要求を実行して、API との対話を開
始します。
例4 .1 API エントリーポイントへのアクセス
ホスト が www. exampl e. co m で、ベース が /api の場合は、要求ではエントリーポイントが以下の
ように表示されます。
GET /api HTTP/1.1
Accept: application/xml
Host: www.example.com
Authorization: [base64 encoded credentials]
HTTP/1.1 200 OK
Content-Type: application/xml
<api>
<link rel="hosts" href="/api/hosts"/>
<link rel="vms" href="/api/vms"/>
...
<product_info>
<name>Red Hat Enterprise Virtualization</name>
<vendor>Red Hat</vendor>
<version revision="0" build="0" minor="1" major="3"/>
</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>
</api>
34
⁠第4 章 エントリーポイント
注記
記載内容をわかりやすくするために、これ以降の例ではすべて Ho st: と Autho ri zati o n: の要
求ヘッダーを省略しています。 また、base はデフォルトの /api パスであることを前提としてい
ます。実際のベースパスは、実装によって異なります。
4 .1. 製品情報
Red Hat Enterprise Virtualization 環境が適切であるかどうかを判断できるように、エントリーポイントに
は pro d uct_i nfo 要素が記載されています。これには、製品のname、vend o r、versi o n などが含ま
れます。
例4 .2 正規の R ed H at En t erp rise Virt u aliz at io n 環境の確認
次の要素は、正規の Red Hat Enterprise Virtualization 3.2 環境を識別します。
<api>
...
<product_info>
<name>Red Hat Enterprise Virtualization</name>
<vendor>Red Hat</vendor>
<version revision="0" build="0" minor="2" major="3"/>
</product_info>
...
</api>
4 .2. リンクの要素
エントリーポイントにアクセスすると、API が公開するすべてのリソースコレクションの l i nk 要素と URI
が提供されます。コレクションには、リレーションタイプを使用して、クライアントが必要とする URI を
特定します。
表4 .1 使用できるリレーションシップのタイプ
リレーションシップ
説明
capabi l i ti es
d atacenters
cl usters
netwo rks
sto rag ed o mai ns
ho sts
vms
d i sks
templ ates
vmpo o l s
d o mai ns
g ro ups
Red Hat Enterprise Virtualization Manager がサポートする機能
データセンター
ホストクラスター
仮想ネットワーク
ストレージドメイン
ホスト
仮想マシン
仮想マシンのディスク
テンプレート
仮想マシンのプール
ID サービスドメイン
インポートした ID サービスグループ
35
REST API ガイド
リレーションシップ
説明
ro l es
users
tag s
events
ロール
ユーザー
タグ
イベント
図4 .1 API エントリーポイントと、API によって公開されるリソースコレクションとの間のリレーション
シップ
注記
応答例に記載されている URI はすべて、例示を目的としています。サーバーが返す全 URI の形式は
不透明です。クライアントはエントリーポイント URI を使って特定のリソースにナビゲートし、リ
レーションシップタイプを使って URI にアクセスします。
サーバーは l i nk 要素の href 属性内に絶対 URI または絶対パス ⁠ [3] を選択して記載するので、ク
ライアントはこれらの形式のいずれかを処理する必要があります。
l i nk 要素には、 特定のコレクションの search URI セットも含まれます。これらの URI は URI テンプ
レート ⁠ [4] を使って検索クエリーを統合します。URI テンプレートの目的はクエリーパラメーターの自然な
HTTP パターンを使って検索式を受け入れることです。クライアントには、URI 構造に関する予備知識は必
要ありません。したがって、クライアントはこれらのテンプレートが不透明であるものとして扱い、URI テ
ンプレートライブラリーを使用してアクセスする必要があります。
各検索クエリーの URI テンプレートは、"co l l ecti o n/search" の形式を使用したリレーションタイプ
で特定されます。
表4 .2 検索クエリーの U R I に関連付けられたリレーションシップ
リレーションシップ
説明
d atacenters/search
cl usters/search
sto rag ed o mai ns/search
ho sts/search
データセンターに対してクエリーを実行します。
ホストのクラスターに対してクエリーを実行します。
ストレージドメインに対してクエリーを実行します。
ホストに対してクエリーを実行します。
36
⁠第4 章 エントリーポイント
リレーションシップ
説明
vms/search
d i sks/search
templ ates/search
vmpo o l s/search
events/search
users/search
仮想マシンに対してクエリーを実行します。
ディスクに対してクエリーを実行します。
テンプレートに対してクエリーを実行します。
仮想マシンのプールに対してクエリーを実行します。
イベントに対してクエリーを実行します。
ユーザーに対してクエリーを実行します。
4 .3. 特殊オブジェクトの要素
特殊オブジェクトの要素は、仮想化環境内の特殊固定リソースとのリレーションシップを定義します。
表4 .3 特殊オブジェクト
リレーションシップ
説明
templ ates/bl ank
仮想化環境のデフォルトの bl ank 仮想マシンテンプレート。このテンプ
レートは、単一のクラスター内のみに存在する標準テンプレートとは対照
的に、全クラスター内に存在します。
仮想化環境のタグ階層のベースとして機能する ro o t タグ
tag s/ro o t
4 .4 . サマリーの要素
サマリーの要素は、システムの統計の俯瞰的な概要を示します。
表4 .4 サマリーの要素
要素
説明
vms
ho sts
users
sto rag e_d o mai ns
仮想マシンの合計数およびアクティブな仮想マシンの合計数
ホストの合計数およびアクティブなホストの合計数
ユーザーの合計数およびアクティブなユーザーの合計数
ストレージドメインの合計数およびアクティブなストレージドメインの合
計数
4 .5. REST ful Service Descript ion Language (RSDL)
RESTful Service D escription Language (RSD L) は、REST API 内の構造および要素の記述を単一の全体
的な XML 仕様で提供します。RSD L を呼び出すには、以下の要求を使用します。
GET /api?rsdl HTTP/1.1
Accept: application/xml
これにより、以下のような形式の XML 文書が提供されます。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rsdl href="/api?rsdl" rel="rsdl">
<description>...</description>
<version major="3" minor="1" build="0" revision="0"/>
<schema href="/api?schema" rel="schema">
<name>...</name>
37
REST API ガイド
<description>...</description>
</schema>
<links>
<link href="/api/capabilities" rel="get">
...
</link>
...
</links>
</rsdl>
表4 .5 R SD L 構造の要素
要素
説明
d escri pti o n
versi o n
プレーンテキストで記述された RSD L 文書
majo r リリース、mi no r リリース、bui l d および revi si o n を含む
API バージョン
XML Schema (XSD ) ファイルへのリンク
API 内の各 l i nk を定義します。
schema
l i nks
各 l i nk 要素には以下のような構造が含まれます。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rsdl href="/api?rsdl" rel="rsdl">
...
<links>
<link href="/api/..." rel="...">
<request>
<http_method>...</http_method>
<headers>
<header>
<name>...</name>
<value>...</value>
</header>
...
</headers>
<body>
<type>...</type>
<parameters_set>
<parameter required="..." type="...">
<name>...</name>
</parameter>
...
</parameters_set>
</body>
</request>
<response>
<type>...</type>
</response>
</link>
...
</links>
</rsdl>
表4 .6 R SD L リンク構造の要素
38
⁠第4 章 エントリーポイント
要素
説明
l i nk
API 要求の URI。URI の属性 (href) およびリレーションシップタイプの
属性 (rel ) が含まれます。
リンクに必要な要求プロパティーを定義します。
そのリンクにアクセスするメソッドのタイプ。REST API アクセスの標準
HTTP メソッド (G ET 、P O ST 、P UT 、D ELET E) が含まれます。
HTTP 要求のヘッダーを定義します。一連の head er 要素が含まれ、
ヘッダーを定義するためのヘッダーの name と val ue がそれぞれに記載
されます。
HTTP 要求の本文を定義します。リソース type と parameter_set が
記載され、それらが要求に req ui red (必須) であるかどうかと、データ
type を定義する属性を示す parameter 要素のセットが含まれま
す。parameter 要素には、変更すべき Red Hat Enterprise
Virtualization Manager プロパティーを定義する name 要素も含まれま
す。また、type が co l l ecti o n に指定されている場合には、さらなる
parameter_set サブセットも含まれます。
HTTP 要求の出力を定義します。出力するリソースの構造を定義する
type 要素が含まれます。
req uest
http_metho d
head ers
bo d y
respo nse
Red Hat Enterprise Virtualization 環境を制御するために全リンクとパラメーター要件をマッピングするメ
ソッドには、アプリケーション内の RSD L を使用します。
4 .6. Red Hat Ent erprise Virt ualiz at ion Windows ゲストの VSS サポート
Red Hat Enterprise Virtualization のバックアップ/リストア API は、q emu - g a を使用した Microsoft
Windows Volume Shadow Copy Service (VSS) との統合を提供します。VSS プロバイダー登録は、ゲス
トツールのデプロイの一環として、ゲストレベルで行われます。
q emu - g a は VSS サポートを提供し、ライブスナップショットは可能な場合に休止を試みます。
4 .7. QEMU ゲストエージェントの概要
Red Hat Enterprise Linux 6.4 では、QEMU Guest Agent (QEMU GA) が Linux のゲスト仮想マシンを破損
から保護していました。スナップショット要求の発行やディスクのバックアップ用コピー作成の前には、
管理スタック (libvirt) が virtio-serial ポートを介して g uest-fsfreeze-freeze Q MP コマンドを
QEMU GA に送信し、このコマンドによりゲストエージェントは FIFR EEZE i o ctl () カーネル関数を用
いて仮想マシンの全ファイルシステムを凍結していました。この i o ctl () 関数は、ゲスト仮想マシンの
Linux カーネルにより実装されています。この関数によってゲスト仮想マシンのカーネル内のファイルシス
テムキャッシュがフラッシュされ、ファイルシステムが一貫性のある状態となり、そのファイルシステム
に対するユーザースペーススレッドの書き込みアクセスが拒否されます。
処理が正常に終了したことを Q EMU G A が報告した場合のみ、lib virt によりスナップショットの作成が
続行されます。完了時には、lib virt が virtio-serial ポートを介して g uest-fsfreeze-thaw Q MP コマ
ンドを Q EMU G A に送信します。このコマンドは、FIT HAW i o ctl () を発行するように Q EMU G A に
指示します。これにより、以前に書き込みアクセスを拒否されたユーザースペーススレッドのブロックが解
除され、通常の処理が再開されます。このプロセスでは、仮想ディスクのスナップショットの作成時に、ア
プリケーションレベルのデータで一貫した状態が確保されませんでした。これが顕著に見られたのは、ス
ナップショットから復元したファイルシステムにおいて、fsck ユーティリティーが問題を検出しなかった
にも拘らず、各種アプリケーションがスナップショットの作成時点から処理を開始できず、ユーザースペー
スの処理によりディスク上のファイルへ内部バッファーの書き込みが行われなかった場合などです。
Red Hat Enterprise Linux 6.5 では、ファイルとアプリケーションレベルの両方での同期 (フラッシング)
が確実に行われます。ゲストのシステム管理者は、アプリケーション固有の凍結/解凍フックスクリプトを
記述してインストールすることができます。ファイルシステムを凍結する前には、Q EMU G A がメイン
39
REST API ガイド
フックスクリプト (Q EMU G A パッケージに同梱) を起動します。メインフックスクリプトは次に、ゲスト
システムの管理者が用意した個々のアプリケーション固有のスクリプトを呼び出し、それによってゲスト仮
想マシンのアプリケーションがすべて一時的に非アクティブ化されます。これらのアクションはすべて、
モードが「freeze」に変わってから実行されます。
ファイルシステムが凍結される直前には、ゲストシステムの管理者のスクリプトにより、データベースおよ
びその他のファイルシステムアプリケーションは作業バッファーを仮想ディスクにフラッシュして、それ
以降のクライアント接続の受け入れを停止します。アプリケーションは次にデータファイルを一貫性のある
状態にし、再アクティブ化された (または新たに起動された) アプリケーションインスタンスで (バックアッ
プから仮想ディスクを復元した後に) プロセスの再開が可能となります。すべてのスクリプトが実行され
て、それぞれのアプリケーションが非アクティブ化され、メインフックスクリプトが返されると、Q EMU
G A はファイルシステムの凍結を続行し、管理スタックがスナップショットを作成します。これらの処理が
すべて完了した後には、スナップショットが作成されていることが確認され、ファイルシステムが書き込み
要求に対するサービスを再開します。このプロセスは解凍と呼ばれます。
解凍は凍結の逆の順序で処理されます。 Q EMU G A は、lib virt から指示を受けて、ゲスト仮想マシンの
ファイルシステムを解凍します。次に (メインスクリプトを使って) 個別のフックスクリプトを起動して、
凍結プロセス中に非アクティブ化されていたアプリケーションを再開または再起動します。
4 .8. VSS トランザクションフロー
バックアップの処理にあたっては、リクエスターとライターが調整して、データをバックアップする安定
したシステムイメージの提供 (シャドーコピーされたボリューム)、用途に基づいたファイルのグループ化、
保存されているデータに関する情報の保存といった複数の作業を実行します。これらはすべて、ライターの
通常のワークフローによる割り込みを最小限に抑えた状態で行う必要があります。
リクエスター (この場合は、バックアップベンダー) は、ライターにメタデータのクエリーを実行し、この
データを処理して、シャドーコピーとバックアップの操作の開始前にライターに通知し、またシャドーコ
ピーとバックアップの操作の後にも再度ライターに通知します。
ゲストツールのインストール後に QEMU VSS プロバイダーを Windows OS で登録する方法は以下のとお
りです。
C:\Users\Administrator>vssadmin list providers
vssadmin 1.1 - Volume Shadow Copy Service administrative command-line
tool
(C) Copyright 2001-2005 Microsoft Corp.
Provider name: 'QEMU Guest Agent VSS Provider'
Provider type: Software
Provider Id: {3629d4ed-ee09-4e0e-9a5c-6d8ba2872aef}
Version: 0.12.1
[3] これらの形式の相違点については、Unifo rm Res o urc e Lo c ato r G eneric Syntax について解説した RFC 文書
を参照してください ( Co llec ted ABNF fo r URI)。
[4] URI テンプレートの形式について解説したインターネットドラフトは、http ://to o ls .ietf.o rg /html/d raftg reg o rio -uritemp late-0 3 に掲載されています。
40
⁠第5章 互換性レベルのバージョン
第5章 互換性レベルのバージョン
Red Hat Enterprise Virtualization Manager に接続している各ホストには、VD SM のバージョンの 1 つが
インストールされています。VD SM は、Hypervisor またはホスト上で稼働し、仮想マシン、ネットワー
ク、ストレージをローカルで管理する機能を提供する仮想化インフラストラクチャー内のエージェントで
す。Red Hat Enterprise Virtualization Manager は、現行または旧バージョンの VD SM を使用して
Hypervisor およびホストの制御を行います。
Manager は同じクラスター内のホスト間における仮想マシンの移行を行います。これは、同じクラスター
内の全ホストに同じバージョンまたはより新しいバージョンの VD SM がインストールされるまで、
Manager が 現行バージョンの VD SM から特定の機能を除外することを意味します。
API はこの概念を、インストールされている VD SM バージョンに対応した各ホストの co mpati bi l i ty
l evel として表示します。versi o n 要素には、互換性レベルを記述する majo r および mi no r の属性が
含まれます。
管理者が単一のクラスター内の全ホストを一定のレベルにアップグレードする場合には、versi o n レベル
は suppo rted _versi o ns 要素の下に表示されます。これは、クラスターのversi o n が、現在そのレベ
ルに更新可能であることを示しています。管理者がデータセンター内のクラスターをすべて一定のレベルに
更新すると、そのデータセンターはそのレベルに更新できるようになります。
5.1. 互換性レベルのアップグレード
例5.1 互換性レベルのアップグレード
API は、Red Hat Enterprise Virtualization Manager 3.4 インスタンスの互換性レベルを以下のように報
告します。
<host ...>
...
<version major="4" minor="14" build="11" revision="0"
full_version="vdsm-4.14.11-5.el6ev"/>
...
</host>
<cluster ...>
...
<version major="3" minor="4"/>
...
</cluster>
<data_center ...>
...
<version major="3" minor="4"/>
</supported_versions>
...
</data_center>
クラスター内の全ホストが VD SM 3. 5 に更新されると、API は以下のように報告します。
<host ...>
...
41
REST API ガイド
<version major="4" minor="16" build="7" revision="4"
full_version="vdsm-4.16.7.4-1.el6ev"/>
...
</host>
<cluster ...>
...
<version major="3" minor="4"/>
<supported_versions>
<version major="3" minor="5"/>
</supported_versions>
...
</cluster>
<data_center ...>
...
<version major="3" minor="4"/>
<supported_versions/>
...
</data_center>
これでクラスターを 3. 5 に更新できるようになりました。 クラスターが更新されると、API は以下のよ
うに報告します。
<cluster ...>
...
<version major="3" minor="5"/>
<supported_versions/>
...
</cluster>
<data_center ...>
...
<version major="3" minor="4"/>
<supported_versions>
<version major="3" minor="5"/>
</supported_versions>
...
</data_center>
API ユーザーがデータセンターを 3. 5 に更新し、アップグレードが完了すると、API によりこのデータ
センターで Red Hat Enterprise Virtualization 3.5 の機能が利用できるようになります。
42
⁠第6 章 機能
第6章 機能
capabi l i ti es コレクションは、Red Hat Enterprise Virtualization 各種バージョンでサポートしている
機能についての情報を提供します。これらの機能には、アクティブな機能や特定のプロパティーに使用可能
な列挙値が含まれます。
Red Hat Enterprise Virtualization 3.2 以降の全バージョンの機能に関する完全一覧を取得するには、以下
の要求を送信します。
GET /api/capabilities/ HTTP/1.1
Content-Type: application/xml
Accept: application/xml
6.1. バージョン依存の機能
capabi l i ti es 要素には、互換性レベルに依存する機能を記述した、任意数のversi o n 要素が含まれま
す。
versi o n 要素には majo r および mi no r のバージョン番号の属性が含まれ、現在のバージョンレベルを
示します。
以下の表現では Red Hat Enterprise Virtualization Manager の
3. 0 、3. 1、3. 2、3. 3、3. 4 、3. 5、3. 6 それぞれに固有の capabilities を示しています。
<capabilities>
<version major="3"
...
</version>
<version major="3"
...
</version>
<version major="3"
...
</version>
<version major="3"
...
</version>
<version major="3"
...
</version>
<version major="3"
...
</version>
<version major="3"
...
</version>
...
</capabilities>
minor="0">
minor="1">
minor="2">
minor="3">
minor="4">
minor="5">
minor="6">
各 versi o n には、指定したバージョンに依存する一連の機能が含まれます。
6.2. 現行バージョン
43
REST API ガイド
current 要素は、指定された versi o n がサポートされている最新の互換性レベルであるかどうかを表し
ます。値は true または fal se のいずれかのブール値です。
<capabilities>
<version major="3" minor="5">
...
<current>true</current>
...
</version>
</capabilities>
6.3. 機能
各バージョンには、互換性のある機能の一覧が含まれています。以下の表には、Red Hat Enterprise
Virtualization 3.6 と互換性のある機能の一覧をまとめています。
表6 .1 機能のタイプ
機能
Transparent Huge Page のメモリーポ
リシー
Gluster サポート
説明
ホストに Tansparent Huge Page の使用可/不可を定義するこ
とができます。許容される値は true または fal se です。
この機能は、Gluster ボリュームおよびブリックをストレージ
として使用するためのサポートを提供します。
POSIX-FS ストレージタイプ
この機能は、POSIX-FS ストレージタイプに対するサポート
を提供します。
ポートミラーリング
仮想ネットワークインターフェースカードにポートミラーリ
ングの使用可/不可を定義することができます。許容される値
は true または fal se です。
サーバー時刻の表示
API で現在の日付と時刻を表示します。
ホストメモリーの表示
特定のホストの合計メモリー容量を表示します。
ホストのソケットの表示
ホスト CPU のトポロジーを定義することができま
す。so ckets、thread s、および co res の 3 つの属性が必
要です。これらの属性は、表示するホストのソケット数、ス
レッド数、ソケットあたりのコア数を定義します。
検索での大文字小文字の区別
case-sensi ti ve= true|false URL パラメーターを提供
することにより、検索クエリーで大文字小文字を区別するかど
うかを指定することができます。
G ET 要求の結果の最大件数
G ET 要求で返される結果の最大件数を指定することができま
す。
JSON コンテンツタイプ
P O ST および P UT 要求で、相関 ID を設定可能にするヘッ
ダーを定義することができます。
ディスクのアクティブ化/非アクティブ
特定の仮想ディスクに対するアクションとして acti vate ま
化
たは d eacti vate を指定することにより、ディスクをアク
ティブ化/非アクティブ化することができます。
ネットワークインターフェースカードの 特定のネットワークインターフェースカードに対するアク
アクティブ化/非アクティブ化
ションとして acti vate または d eacti vate を指定するこ
とにより、ネットワークインターフェースカードをアクティ
ブ化/非アクティブ化することができます。
スナップショットのリファクタリング
仮想マシンのスナップショットのリファクタリングを行うこ
とができます。
44
⁠第6 章 機能
機能
説明
指定したストレージドメインからのテン D ELET E 要求を使用して、特定のストレージドメインから仮
プレートディスクの削除
想マシンテンプレートのディスクを削除することができま
す。
フローティングディスク
フローティングディスクとは、どの仮想マシンにもアタッチ
されていないディスクです。この機能により、フローティン
グディスクは特定の仮想マシン下ではなく、root コレクショ
ンに表示されます。
非同期削除
asyncURL パラメーターを指定することにより、D ELET E 要
求が非同期で実行されるように指定することができます。
セッションベースの認証
適切なヘッダーを提供することにより、クライアント/サー
バーセッションを維持できるようにし、要求ごとにログイン
する必要をなくします。
仮想マシンのアプリケーション
特定の仮想マシンにインストールされているアプリケーショ
ンを一覧表示することができます。この一覧は、その仮想マシ
ンの appl i cati o ns 要素にあります。
VirtIO-SCSI サポート
この機能は、準仮想化 SCSI コントローラーデバイスに対する
サポートを提供します。
カスタムリソースコメント
データセンターおよびその他のリソースにカスタムコメントを
追加することができます。
ホストの機能のリフレッシュ
ホスト上のデータを同期して、特定のホストが利用できる
ネットワークインターフェースの一覧をリフレッシュするこ
とができます。
メモリースナップショット
仮想マシンのスナップショットの一部としてメモリーの状態
を含めることができます。
ウォッチドッグデバイス
仮想マシン用のウォッチドッグデバイスを作成することがで
きます。
SSH 認証メソッド
管理者ユーザーのパスワードまたは SSH 公開鍵を使用して、
SSH を介したホストとの認証を行うことができます。
SPM の強制的な選択
ホストを SPM として強制的に選択することができます。
コンソールデバイス
仮想マシンへのコンソールデバイスのアタッチを制御するこ
とができます。
ストレージドメイン用のストレージサー 特定のストレージドメインとのストレージサーバーの接続を確
バー接続
認することができます。
ストレージサーバー接続のアタッチ/デ
特定のストレージドメインにストレージサーバー接続をア
タッチ
タッチ/デタッチすることができます。
QXL 用の単一 PCI
単一の PCI ゲストデバイスを介して複数のビデオデバイスを
表示することができます。
OVF 設定からの仮想マシン追加
提供した OVF 設定から仮想マシンを追加することができま
す。
仮想ネットワークインターフェースカー 特定の仮想ネットワークインターフェースカードのサービス
ドのプロファイル
の品質、カスタムプロパティー、ポートミラーリングを定義
するプロファイルを設定することができます。
イメージストレージドメイン (テクノロ OpenStack Image Service (Glance) などのイメージスト
ジープレビュー)
レージドメインからのイメージのインポートとエクスポートを
行うことができます。
仮想マシンの完全修飾ドメイン名
特定の仮想マシンの完全修飾ドメイン名を取得することができ
ます。
仮想マシンへのディスクスナップショッ この機能は、仮想マシンにディスクスナップショットをア
トのアタッチ
タッチするためのサポートを提供します。
Cloud-Init
Cloud-Init を使用して仮想マシンの初期化を行うことができま
す。
45
REST API ガイド
機能
説明
Gluster ブリック管理
mi g rate と D ELET E のアクションを使用して、データ移行
で Gluster ブリックを削除することができます。mi g rate ア
クションおよび sto pmi g rate アクションでは、データを移
行してブリックを再利用することができます。
追加のコンテキストのディスクをコピーおよび移動すること
ができます。
ラベルを使用してホストにネットワークをプロビジョニング
することができます。
1 回のアクションで仮想マシンを再起動することができます。
バックエンドディスクのコピーと移動
ネットワークラベル
仮想マシンの再起動
機能の要素およびそれらの属性の完全な一覧は、該当するバージョンのセクションの最上部にあります。
<capabilities>
<version major="3" minor="4">
...
<features>
<feature>
<name>Transparent-Huge-Pages Memory Policy</name>
<transparent_huepages/>
</feature>
</features>
...
</version>
</capabilities>
46
⁠第7 章 共通の機能
第7章 共通の機能
7.1. 要素のプロパティーを表すアイコン
注記
本ガイドでは、全体を通して、各リソースの要素を表にまとめて説明しています。各表にはプロパ
ティーの列があり、要素のプロパティーをアイコンで示しています。これらのアイコンの意味につ
いては、表7.1「要素のプロパティーを表すアイコン」 で説明しています。
表7.1 要素のプロパティーを表すアイコン
プロパティー
説明
作成時に必要
これらの要素は、リソースの作成時にクライアント提供の
リソース表現に必ず記載する必要がありますが、リソース
の更新時には必須ではありません。
これらの要素の値は、リソースの更新時には変更できませ
ん。API ユーザーによって値が変更されていない場合にの
み、更新時にクライアント提供の表現にこれらの要素を記
載してください。変更されている場合には API がエラーを
報告します。
これらの要素は読み取り専用です。読み取り専用要素の値
の作成や変更はできません。
更新不可
読み取り専用
アイコン
7.2. 表現
7.2.1. 表現
API では、以下の XML ドキュメント構造でリソースの表現を構築します。
<resource id="resource_id" href="/api/collection/resource_id">
<name>Resource-Name</name>
<description>A description of the resource</description>
...
</resource>
仮想マシンの場合には、表現は以下のようになります。
<vm id="5b9bbce5-0d72-4f56-b931-5d449181ee06"
href="/api/vms/5b9bbce5-0d72-4f56-b931-5d449181ee06">
<name>RHEL6-Machine</name>
<description>Red Hat Enterprise Linux 6 Virtual Machine</description>
...
</vm>
7.2.2. リソース表現に共通の属性
リソース表現にはすべて、共通属性セットが含まれます。
47
REST API ガイド
表7.2 リソース表現に共通の属性
属性
タイプ
説明
id
GUID
href
文字列
仮想化インフラストラクチャー内の各リ
ソースには i d が含まれ、 グローバル一
意識別子 (GUID ) として機能します。
GUID は、リソース識別の第一手段で
す。
絶対パスとして表示したリソースの正規
の場所です。
プロパティー
7.2.3. リソース表現に共通の要素
すべてのリソース表現には、共通する要素セットが含まれます。
表7.3 リソース表現に共通の要素
要素
タイプ
説明
name
文字列
d escri pti o n
文字列
ユーザーによって提供される、人間が判
読できるリソース名で、name はそのタ
イプの全リソースで一意です。
ユーザーによって提供される、人間が判
読できる自由形式のリソースの説明で
す。
プロパティー
7.3. コレクション
7.3.1. コレクション
コレクションは、同じタイプのリソースのセットです。API は、最上位コレクションとサブコレクションの
両方を提供します。最上位コレクションの例としては、環境内の全仮想化ホストを含む ho sts コレクショ
ンがあげられます。また、サブコレクションの例としては、ホストリソースにアタッチされた全ネットワー
クインターフェースカードのリソースを含む ho st. ni cs コレクションがあげられます。
7.3.2. コレクション内の全リソースの一覧
エントリーポイントから取得したコレクション URI に対して G ET 要求を実行して、コレクション内のリ
ソースの一覧を取得します。
Accept HTTP ヘッダーを追加して、応答形式の MIME タイプを定義します。
GET /api/[collection] HTTP/1.1
Accept: [MIME type]
7.3.3. 拡張リソースのサブコレクションの一覧
Accept ヘッダーに d etai l パラメーターを記載すると、API はコレクションの表現を拡張してサブコレ
クションを追加します。
GET /api/collection HTTP/1.1
Accept: application/xml; detail=subcollection
48
⁠第7 章 共通の機能
複数のサブコレクションを追加するには 2 つの方法があります。第 1 の方法では、以下に示したように、
複数の d etai l パラメーターを区切って記述します。
GET /api/collection HTTP/1.1
Accept: application/xml; detail=subcollection1; detail=subcollection2
第 2 の方法では、以下に示したように、単一の d etai l パラメーターで、サブコレクションを + 演算子で
区切ります。
GET /api/collection HTTP/1.1
Accept: application/xml;
detail=subcollection1+subcollection2+subcollection3
API は、以下のメインコレクションで、拡張サブコレクションをサポートしています。
表7.4 拡張サブコレクションを使用するコレクション
コレクション
拡張サブコレクションのサポート
ho sts
vms
stati sti cs
stati sti cs、ni cs、d i sks
例7.1 vms コレクション内の拡張された st at ist ics/n ics/d isks サブコレクションの要求
GET /api/vms HTTP/1.1
Accept: application/xml; detail=statistics+nics+disks
7.3.4 . クエリーを使用したコレクションの検索
"co l l ecti o n/search" リンクに対する G ET 要求は、そのコレクションの検索クエリーとなります。
API は、検索クエリーの制約を満たすコレクション内のリソースのみを返します。
GET /api/collection?search={query} HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<collection>
<resource id="resource_id" href="/api/collection/resource_id">
...
</resource>
...
</collection>
7.3.5. 検索結果の最大表示件数のパラメーター
結果一覧のサイズを制限するには、max URL パラメーターを使用します。Red Hat Enterprise
Virtualization 3.4 より前のバージョンでは、結果のデフォルトサイズは SearchResultsLimit パラメーター
で制限されていました。Red Hat Enterprise Virtualization 3.4 以降のバージョンでは、
SearchResultsLimit パラメーターは REST API に効果がないため、max パラメーターを指定せずに API 検
49
REST API ガイド
索クエリーを実行すると、すべての値が返されてしまいます。API 検索クエリーによる UI のパフォーマン
ス低下を防ぐためには、max パラメーターを指定することを推奨します。
GET /api/collection;max=1 HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<collection>
<resource id="resource_id" href="/api/collection/resource_id">
<name>Resource-Name</name>
<description>A description of the resource</description>
...
</resource>
</collection>
7.3.6. 大文字と小文字の区別
デフォルトでは、検索クエリーはすべて大文字と小文字が区別されます。大文字/小文字の区別を切り替え
るためのブール値オプションは、URL 構文で提供されます。
例7.2 大文字/小文字を区別しない検索クエリー
GET /api/collection;case-sensitive=false?search={query} HTTP/1.1
Accept: application/xml
7.3.7. クエリーの構文
API は、URI テンプレートを使用して G ET 要求による検索 q uery を実行します。
GET /api/collection?search={query} HTTP/1.1
Accept: application/xml
q uery テンプレートの値は、API が co l l ecti o n に送る検索クエリーを参照します。この q uery は、
Red Hat Enterprise Virtualization 検索クエリー言語と同じ形式を使用します。
(cri teri a) [so rtby (el ement) asc| d esc]
so rtby 句はオプションです。結果をソートする場合にのみ必要となります。
表7.5 検索クエリーの例
コレクション
条件
結果
ho sts
vms. status= up
vms
d o mai n= q a. co mpany. co m
vms
users. name= mary
up 状態の仮想マシンを実行中の
全ホストの一覧を表示します。
指定したドメインで稼働中の全仮
想マシンの一覧を表示します。
ユーザー名が mary のユーザーに
属する全仮想マシンの一覧を表示
します。
50
⁠第7 章 共通の機能
コレクション
条件
結果
events
severi ty>no rmal so rtby
ti me
events
severi ty>no rmal so rtby
ti me d esc
重大度が no rmal を超えるすべ
ての events の一覧を表示
し、ti me 要素値でソートしま
す。
重大度が no rmal を超えるすべ
ての events の一覧を表示
し、ti me 要素値の降順にソート
します。
API は、q uery テンプレートを URL エンコードして、演算子や空白など予約文字を変換する必要がありま
す。
例7.3 U R L エンコードされた検索クエリー
GET /api/vms?search=name%3Dvm1 HTTP/1.1
Accept: application/xml
7.3.8. ワイルドカード
検索クエリーで、値の一部の代わりに、アスタリスクをワイルドカードとして使用します。
例7.4 ワイルドカードを使用した n ame= vm* の検索クエリー
GET /api/vms?search=name%3Dvm* HTTP/1.1
Accept: application/xml
このクエリーは、vm1、vm2、vma、vm-webserver など vm で始まる仮想マシン名をすべて表示しま
す。
例7.5 ワイルドカードを使用した n ame= v*1 の検索クエリー
GET /api/vms?search=name%3Dv*1 HTTP/1.1
Accept: application/xml
このクエリーは、vm1、vr1、vi rtual machi ne1 など v で始まり 1 で終わる仮想マシン名をすべて表
示します。
7.3.9. ページネーション
Red Hat Enterprise Virtualization 環境の中には、リソースのコレクションが大量に含まれている場合があ
りますが、API は 1 つのコレクションに対する 1 回の検索クエリーに設定されているデフォルト数のリソー
スのみを表示します。デフォルト数以上のリソースを表示するには、pag e コマンドを検索クエリーに追加
すると、API はコレクションを複数のページに分割します。
例7.6 リソースのページネーション
51
REST API ガイド
以下の例では、1 つのコレクション内の複数のリソースをページネーションします。URL エンコードさ
れた要求は次のようになります。
GET /api/collection?search=page%201 HTTP/1.1
Accept: application/xml
次の結果ページを表示させる場合は pag e 値を増やします。
GET /api/collection?search=page%202 HTTP/1.1
Accept: application/xml
以下の例のように、pag e コマンドは、検索クエリー内で他のコマンドと併用することができます。
GET /api/collection?search=sortby%20element%20asc%20page%202 HTTP/1.1
Accept: application/xml
このクエリーにより、コレクション一覧内の第 2 ページが選択した要素の順に表示されます。
重要
REST API はステートレスです。要求はすべて 1 つずつ独立しているため、別の要求との間で状態を
保持することはできません。そのため、要求と要求の間でステータスが変更されると、ページの結果
に整合性がなくなります。
たとえば、仮想マシンの一覧から特定のページを要求し、次のページを要求する前にステータスが変
更された場合は、出力される結果でエントリーが足りないか、重複エントリーが含まれている可能性
があります。
7.3.10. コレクション内のリソース作成
新規リソースの表現を含むコレクション URI に対して P O ST 要求を実行して、新規リソースを作成しま
す。
P O ST 要求には、C o ntent-T ype ヘッダーが必要です。このヘッダーは、要求の一部として、本文コンテ
ンツ内の表現の MIME タイプを API に通知します。
Accept HTTP ヘッダーを追加して、応答形式の MIME タイプを定義します。
各リソースタイプには、それぞれ固有の必須プロパティーがあります。これらのプロパティーは、新規リ
ソース作成時にクライアントから提供されます。詳細については、各リソースタイプの説明を参照してくだ
さい。
必須プロパティーが存在しない場合には、作成が失敗し、表現に不足している要素が示されます。
POST /api/[collection] HTTP/1.1
Accept: [MIME type]
Content-Type: [MIME type]
[body]
7.3.11. 非同期要求
52
⁠第7 章 共通の機能
Expect: 20 1-created ヘッダーでユーザーによって要求が無効化されない限り、API は非同期の
P O ST 要求を行います。
たとえば、仮想マシン、ディスク、スナップショット、テンプレートなど特定のリソースは非同期に作成さ
れます。非同期のリソース作成の要求を実行すると 20 2 Accepted のステータスになります。20 2
Accepted のリソースの初期ドキュメント構造には creati o n_status 要素と作成ステータス更新用リ
ンクも含まれます。以下が例となります。
POST /api/collection HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<resource>
<name>Resource-Name</name>
</resource>
HTTP/1.1 202 Accepted
Content-Type: application/xml
<resource id="resource_id" href="/api/collection/resource_id">
<name>Resource-Name</name>
<creation_status>
<state>pending</state>
</creation status>
<link rel="creation_status"
href="/api/collection/resource_id/creation_status/creation_status_id"/>
...
</resource>
creati o n_status リンクに対して G ET 要求を実行すると、作成ステータスの更新が提供されます。
GET /api/collection/resource_id/creation_status/creation_status_id
HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<creation id="creation_status_id"
href="/api/collection/resource_id/creation_status/creation_status_id">
<status>
<state>complete</state>
</status>
</creation>
非同期リソースの作成をオーバーライドするには Expect: 20 1-created ヘッダーが必要です。
POST /api/collection HTTP/1.1
Accept: application/xml
Content-Type: application/xml
Expect: 201-created
53
REST API ガイド
<resource>
<name>Resource-Name</name>
</resource>
7.4 . リソース
7.4 .1. リソース
リソースは、RESTful Web サービスのデータソースです。各リソースタイプには、リソース表現 (通常
XML または JSON) を形成するために REST API が抽象化する共通のパラメーターセットが含まれていま
す。ユーザーはリソース表現を表示して、パラメーターを編集し、API 内にあるリソースの URL にその表
現を送り返して、リソースを変更することができます。またユーザーは、REST を介して個別のリソースを
削除することもできます。
RESTful Web サービスは、リソースをコレクションにグループ化する作業も行います。ユーザーはコレク
ション内の全リソースの表現を表示することができます。またユーザーは、リソース表現を特定のコレク
ションに送信して、そのコレクション内に新たなリソースが作成することもできます。
7.4 .2. リソースの取得
コレクション一覧から取得した URI に対して G ET 要求を実行し、リソースのステータスを取得します。
Accept HTTP ヘッダーを追加して、応答形式の MIME タイプを定義します。
GET /api/[collection]/[resource_id] HTTP/1.1
Accept: [MIME type]
リソースからの追加情報は、Al l -C o ntent: true ヘッダーを使用して取得することができます。
RESTful Service D escription Language (RSD L) により、どのリンクがこのヘッダーをサポートするかが
記述されます。
GET /api/[collection]/[resource_id] HTTP/1.1
Accept: [MIME type]
All-Content: true
7.4 .3. リソースの更新
前回のリソース URI G ET 要求からの更新詳細を含む P UT 要求を実行して、リソースのプロパティーを変
更します。変更可能なプロパティーに関する詳細は、各リソースタイプの説明を参照してください。
P UT 要求には、C o ntent-T ype ヘッダーが必要です。このヘッダーは、要求の一部として、本文コンテ
ンツ内の表現の MIME タイプを API に通知します。
Accept HTTP ヘッダーを追加して、応答形式の MIME タイプを定義します。
PUT /api/collection/resource_id HTTP/1.1
Accept: [MIME type]
Content-Type: [MIME type]
[body]
54
⁠第7 章 共通の機能
これには、API ユーザーが変更を試みた、不変のリソースプロパティーは含まれません。完全に不変のリ
ソースプロパティーの変更を試みると、API は応答本文内のエラーメッセージ表現で競合を報告します。
表現から省略されたプロパティーは無視されるため変更されません。
7.4 .4 . リソースの削除
URI に対して D ELET E 要求を実行して、リソースを削除します。
Accept HTTP ヘッダーを追加して、応答形式の MIME タイプを定義します。
DELETE /api/[collection]/[resource_id] HTTP/1.1
Accept: [MIME type]
追加のプロパティーを指定するために、D ELET E 要求内にオプションの本文コンテンツが必要な場合があ
ります。オプションの本文コンテンツ付き D ELET E 要求には、本文コンテンツ内の表現の MIME タイプを
API に通知する C o ntent-T ype ヘッダーが必要です。D ELET E 要求に本文コンテンツがない場合は
C o ntent-T ype ヘッダーは省略します。
7.4 .5. サブコレクションのリレーションシップ
サブコレクションのリレーションシップは、リソースとサブコレクション間の階層リンクを定義します。
サブコレクションは、親リソースに関連して存在したり、意味を持ったりします。たとえば、仮想マシンに
複数のネットワークインターフェースがある場合は、API は仮想マシンリソースとネットワークインター
フェースのサブコレクション間のリレーションシップをマッピングすることになります。
サブコレクションは、次のリレーションシップタイプのモデリングに使用します。
1 つの親リソースに複数の子リソースが含まれるようにしたり、1 つの子リソースが複数の親リソースに
含まれるようにしたりすることが可能です。たとえば、仮想マシンには、複数のディスクを設定するこ
とができ、一部のディスクは複数の仮想マシンで共有されます。
マッピングされるリソースは、親リソースに依存します。親リソースなしでは依存するリソースは存在
できません (例: 仮想マシンとスナップショット間のリンク)。
マッピングされるリソースは、親リソースからは独立して存在しますが、データはそのリレーション
シップで関連付けられています (例: クラスターとネットワーク間のリンク)。
API は、l i nk rel = 属性を使用して、リソースとサブコレクションとのリレーションシップを定義しま
す。
GET /api/collection/resource_id HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<resource id="resource_id" href="/api/collection/resource_id">
...
<link rel="subcollection"
href="/api/collection/resource_id/subcollection"/>
...
</resource>
次に、サブコレクションに対してクエリーを実行します。
55
REST API ガイド
GET /api/collection/resource_id/subcollection HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<subcollection>
<subresource id="subresource_id"
href="/api/collection/resource_id/subcollection/subresource_id">
...
</subresource>
...
</subcollection>
7.4 .6. XML 要素のリレーションシップ
XML 要素のリンクは、リソース間のリレーションシップを表現するためのサブコレクションの代わりとし
て機能します。XML 要素のリンクは、単にリンク先の要素をポイントする「href」属性が記述した要素で
す。
XML 要素のリンクは、依存関係やリレーションシップに関連付けられたデータのないリソース間の単純な
1:N マッピングのモデリングに使用されます。(例: ホストとクラスター間のリレーションシップ)
このようなリレーションシップには、以下のような例があります。
サブコレクション内のリソースから親リソースへのバックリンク
任意のリレーションシップがあるリソース間のリンク
例7.7 XML 要素を使用した、サブコレクションリソースからリソースへのバックリンク
GET /api/collection/resource_id/subcollection/subresource_id HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/xml
<subcollection>
<subresource id="subresource_id"
href="/api/collection/resource_id/subcollection/subresource_id">
<resource id="resource_id" href="/api/collection/resource_id"/>
...
</subresource>
</subcollection>
7.4 .7. アクション
大半のリソースには、標準の HTTP メソッドでは実現できない関数を提供するアクションリンクの一覧が
含まれています。
<resource>
...
<actions>
<link rel="start" href="/api/collection/resource_id/start"/>
56
⁠第7 章 共通の機能
<link rel="stop" href="/api/collection/resource_id/stop"/>
...
</actions>
...
</resource>
API は、提供された URI に対して P O ST 要求を実行することによってアクションを呼び出します。P O ST
の本文には、共通およびタスク固有のパラメーターをカプセル化した acti o n 表現が必要です。
表7.6 共通のアクションパラメーター
要素
説明
async
サーバーが 20 2 Accepted で即時に応答し、完了確認のポーリングのた
めの href リンクがアクション表現に記載されている場合はtrue に指定
します。
猶予期間 (ミリ秒単位)。アクション開始前に満了する必要があります。
g race_peri o d
個々のアクションおよびそれらのパラメーターについては、各リソースタイプの説明を参照してください。
特定のアクションには必須のパラメーターがあり、それらが指定されていない場合には faul t 応答で示さ
れます。
P O ST 要求には本文コンテンツに XML 表現が必要なため、アクションにもC o ntent-T ype:
appl i cati o n/xml ヘッダーが必要です。
アクションが非同期で開始されると、20 2 Accepted の即時応答によりタスクのステータスをモニタリン
グするためのリンクが提供されます。
POST /api/collection/resource_id/action HTTP/1.1
Content-Type: application/xml
Accept: application/xml
<action>
<async>true</async>
</action>
HTTP/1.1 202 Accepted
Content-Type: application/xml
<action id="action_id"
href="/api/collection/resource_id/action/action_id">
<async>true</async>
...
</action>
この後にアクション URL に対して G ET を実行すると、非同期タスクのステータス表示が提供されます。
表7.7 アクションのステータス
ステータス
説明
pend i ng
i n_pro g ress
co mpl ete
fai l ed
タスクがまだ開始されていない状態です。
タスクを実行中
タスクが正常に完了
タスクが失敗 (返される acti o n 表現にはエラーの詳細を記述する
faul t が含まれる)
57
REST API ガイド
タスクが完了すると、そのアクションのデータは一定期間維持されます。この期間が満了した後に G ET を
実行すると、30 1 Mo ved P ermanentl y となり、ターゲットリソースに戻るようリダイレクトされま
す。
GET /api/collection/resource_id/action/action_id HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<action id="action_id"
href="/api/collection/resource_id/action/action_id">
<status>
<state>pending</state>
</status>
<link rel="parent" /api/collection/resource_id"/>
<link rel="replay" href="/api/collection/resource_id/action"/>
</action>
アクション表現には rel 属性によって識別される複数のリンクも記載されます。
表7.8 アクションのリレーションシップ
タイプ
説明
parent
repl ay
このアクションのリソースに戻るリンク
元のアクション URI に戻るリンク。この URI に POST を実行すると、ア
クションが再度開始されます。
7.4 .8. パーミッション
各リソースには permi ssi o ns サブコレクションが含まれます。各 permi ssi o ns には user、割り当て
られた ro l e、指定リソースなどが含まれます。 以下が例となります。
GET /api/collection/resource_id/permissions HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<permissions>
<permission id="permission-id"
href="/api/collection/resource_id/permissions/permission_id">
<role id="role_id" href="/api/roles/role_id"/>
<user id="user_id" href="/api/users/user_id"/>
<resource id="resource_id" href="/api/collection/resource_id"/>
</permission>
...
</permissions>
API ユーザーがリソースの permi ssi o ns サブコレクションに対して、permi ssi o n 表現および
C o ntent-T ype: appl i cati o n/xml ヘッダーを記載した P O ST を送信すると、リソースは新規パー
ミッションを取得します。以下の例に示したように、各新規パーミッションには ro l e と user が必要で
す。
58
⁠第7 章 共通の機能
POST /api/collection/resource_id/permissions HTTP/1.1
Content-Type: application/xml
Accept: application/xml
<permission>
<role id="role_id"/>
<user id="user_id"/>
</permission>
HTTP/1.1 201 Created
Content-Type: application/xml
<permission id="permission_id"
href="/api/resources/resource_id/permissions/permission_id">
<role id="role_id" href="/api/roles/role_id"/>
<user id="user_id" href="/api/users/user_id"/>
<resource id="resource_id" href="/api/collection/resource_id"/>
</permission>
7.4 .9. エラーの処理
エラーによっては、標準の HTTP ステータスコード以外に、詳細な説明を必要とするものがあります。た
とえば API は、リソース状態の更新またはアクションの失敗を、応答エンティティー本文に faul t 表現を
指定して報告します。fault 表現には reaso n と d etai l の文字列が含まれます。クライアント
は、faul t または 応答ステータスコードに応じた、想定されるリソース表現を抽出することによって、失
敗した要求に対応する必要があります。このような場合の対処方法は、各リソースの説明で明確に記載して
います。
PUT /api/collection/resource_id HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<resource>
<id>id-update-test</id>
</resource>
HTTP/1.1 409 Conflict
Content-Type: application/xml
<fault>
<reason>Broken immutability constraint</reason>
<detail>Attempt to set immutable field: id</detail>
</fault>
59
REST API ガイド
第8章 バックアップ/リストア API
バックアップ/リストア API は、全体またはファイルレベルでの仮想マシンのバックアップと復元を可能に
する機能のコレクションです。この API は、ライブスナップショットや REST API などの Red Hat
Enterprise Virtualization の複数のコンポーネントを組み合わせて、独立系のソフトウェアプロバイダーの
提供するバックアップソフトウェアが実装された仮想マシンにアタッチできる一時ボリュームを作成/操作
します。
サポート対象のサードパーティーバックアップベンダーについては、Red Hat Marketplace で Red Hat
Enterprise Virtualization Ecosystem をご確認ください。
8.1. 仮想マシンのバックアップ
バックアップ/リストア API を使用して仮想マシンをバックアップします。以下の手順は、バックアップ用
の仮想マシンと、バックアップを管理するソフトウェアのインストール先となる仮想マシンとの合計 2 台
が用意されていることを前提とします。
手順8.1 仮想マシンのバックアップ
1. REST API を使用して、バックアップする仮想マシンのスナップショットを作成します。
POST /api/vms/11111111-1111-1111-1111-111111111111/snapshots/
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<snapshot>
<description>BACKUP</description>
</snapshot>
注記
仮想マシンのスナップショットを作成すると、スナップショット作成時点の仮想マシンの設
定データのコピーは、そのスナップショット下の i ni ti al i zati o n 内の
co nfi g urati o n 属性の d ata 属性に保管されます。
重要
共有可能とマークされたディスクまたは直接 LUN ディスクをベースとするディスクのス
ナップショットは作成できません。
2. スナップショット下の d ata 属性から仮想マシンの設定データを取得します。
GET /api/vms/11111111-1111-1111-1111111111111111/snapshots/11111111-1111-1111-1111-111111111111
HTTP/1.1
Accept: application/xml
Content-type: application/xml
60
⁠第8 章 バックアップ/リストア API
3. スナップショットのディスク ID とスナップショット ID を特定します。
GET /api/vms/11111111-1111-1111-1111111111111111/snapshots/11111111-1111-1111-1111-111111111111/disks
HTTP/1.1
Accept: application/xml
Content-type: application/xml
4. バックアップ用仮想マシンにスナップショットをアタッチしてディスクをアクティブ化します。
POST /api/vms/22222222-2222-2222-2222-222222222222/disks/ HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk id="11111111-1111-1111-1111-111111111111">
<snapshot id="11111111-1111-1111-1111-111111111111"/>
<active>true</active>
</disk>
5. バックアップ用仮想マシンでバックアップソフトウェアを使用して、スナップショット上のデータ
をバックアップします。
6. バックアップ用仮想マシンからスナップショットのディスクをデタッチします。
DELETE /api/vms/22222222-2222-2222-2222222222222222/disks/11111111-1111-1111-1111-111111111111 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<detach>true</detach>
</action>
7. オプションとして、スナップショットを削除します。
DELETE /api/vms/11111111-1111-1111-1111111111111111/snapshots/11111111-1111-1111-1111-111111111111
HTTP/1.1
Accept: application/xml
Content-type: application/xml
別の仮想マシンにインストールしたバックアップソフトウェアを使用して、一定時点の仮想マシンがバッ
クアップされました。
8.2. 仮想マシンの復元
バックアップ/リストア API を使用してバックアップした仮想マシンを復元します。以下の手順は、以前の
バックアップの管理に使用するソフトウェアがインストール済みの仮想マシン 1 台が用意されていること
を前提とします。
手順8.2 仮想マシンの復元
1. バックアップ用仮想マシンにディスクをアタッチします。
61
REST API ガイド
POST /api/vms/22222222-2222-2222-2222-222222222222/disks/ HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk id="11111111-1111-1111-1111-111111111111">
</disk>
2. バックアップソフトウェアを使用して、ディスクにバックアップを復元します。
3. バックアップ用仮想マシンからディスクをデタッチします。
DELETE /api/vms/22222222-2222-2222-2222222222222222/disks/11111111-1111-1111-1111-111111111111 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<detach>true</detach>
</action>
4. 復元する仮想マシンの設定データを使用して、新規仮想マシンを作成します。
POST /api/vms/ HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<cluster>
<name>cluster_name</name>
</cluster>
<name>NAME</name>
...
</vm>
5. 新規仮想マシンにディスクをアタッチします。
POST /api/vms/33333333-3333-3333-3333-333333333333/disks/ HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk id="11111111-1111-1111-1111-111111111111">
</disk>
バックアップ/リストア API を使用して作成したバックアップで、仮想マシンを復元しました。
62
⁠第9 章 データセンター
第9章 データセンター
9.1. データセンターの要素
d atacenters コレクションは、Red Hat Enterprise Virtualization 環境内のデータセンターに関する情報
を提供します。API ユーザーは、エントリーポイント URI から取得した rel = "d atacenters" リンクでこ
の情報にアクセスします。
以下の表には、データセンターリソースの表現に含まれる特定の要素をまとめています。
表9 .1 データセンターの要素
要素
タイプ
説明
name
文字列
d escri pti o n
文字列
l i nk
rel = "sto rag ed o mai ns"
リレーションシッ
プ
l i nk rel = "cl usters"
リレーションシッ
プ
l i nk rel = "netwo rks"
リレーションシッ
プ
l i nk
rel = "permi ssi o ns"
リレーションシッ
プ
l i nk rel = "q uo tas"
リレーションシッ
プ
l o cal
ブール値: true ま
たは false
sto rag e_fo rmat
列挙型
versi o n majo r= mi no r=
suppo rted _versi o ns
複合型
複合型
status
以下参照
プレーンテキスト形式の人間が
判読できるデータセンター
名。name は全クラスターリ
ソースで一意です。
プレーンテキスト形式の人間が
判読できるプロバイダーの説明
そのデータセンターにアタッ
チされているストレージドメイ
ンのサブコレクションへのリ
ンク
そのデータセンターにアタッ
チされているクラスターのサブ
コレクションへのリンク
そのデータセンターで利用可能
なネットワークのサブコレク
ションへのリンク
データセンターパーミッショ
ンのサブコレクションへのリ
ンク
そのデータセンターに関連付け
られているクォータのサブコ
レクションへのリンク
データセンターがローカルの
データセンター (例: all-in-one
インスタンスで作成されたも
の) かどうかを指定します。
データセンターのストレージ形
式のバージョンの記述。列挙
値の一覧は capabi l i ti es
に記載されています。
データセンターの互換性レベル
versi o n majo r= mi no r=
など、データセンターで利用可
能なバージョンレベルの一覧
データセンターのステータス
プロパティー
63
REST API ガイド
status に
は、uni ni ti al i zed 、up、mai ntenance、no t_o perati o nal 、pro bl emati c、co ntend の列
挙値のいずか 1 つが記載されます。これらのステータスは capabi l i ti es の下の
d ata_center_states に一覧表示されています。
9.2. データセンターの XML 表現
例9 .1 データセンターの XML 表現
<data_center href="/api/datacenters/00000000-0000-0000-0000000000000000"
id="00000000-0000-0000-0000-000000000000">
<name>Default</name>
<description>The default Data Center</description>
<link href="/api/datacenters/00000000-0000-0000-0000000000000000/storagedomains" rel="storagedomains"/>
<link href="/api/datacenters/00000000-0000-0000-0000000000000000/clusters" rel="clusters"/>
<link href="/api/datacenters/00000000-0000-0000-0000000000000000/networks" rel="networks"/>
<link href="/api/datacenters/00000000-0000-0000-0000000000000000/permissions" rel="permissions"/>
<link href="/api/datacenters/00000000-0000-0000-0000000000000000/quotas" rel="quotas"/>
<local>false</local>
<storage_format>v3</storage_format>
<version major="3" minor="4"/>
<supported_versions>
<version major="3" minor="4"/>
</supported_versions>
<status>
<state>up</state>
</status>
</data_center>
9.3. データセンターの JSON 表現
例9 .2 データセンターの JSO N 表現
{
"data_center" : [ {
"local" : "false",
"storage_format" : "v3",
"version" : {
"major" : "3",
"minor" : "5"
},
"supported_versions" : {
"version" : [ {
"major" : "3",
64
⁠第9 章 データセンター
"minor" : "5"
} ]
},
"status" : {
"state" : "up"
},
"name" : "Default",
"description" : "The default Data Center",
"href" : "/api/datacenters/00000002-0002-0002-0002-000000000255",
"id" : "00000002-0002-0002-0002-000000000255",
"link" : [ {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255/storagedomains",
"rel" : "storagedomains"
}, {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255/clusters",
"rel" : "clusters"
}, {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255/networks",
"rel" : "networks"
}, {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255/permissions",
"rel" : "permissions"
}, {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255/quotas",
"rel" : "quotas"
}, {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255/iscsibonds",
"rel" : "iscsibonds"
}, {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255/qoss",
"rel" : "qoss"
} ]
} ]
}
9.4 . メソッド
9.4 .1. 新しいデータセンターの作成
新規データセンターの作成には name、l o cal の要素が必要です。
例9 .3 データセンターの作成
POST /api/datacenters HTTP/1.1
Accept: application/xml
65
REST API ガイド
Content-type: application/xml
<data_center>
<name>NewDatacenter</name>
<local>false</local>
</data_center>
9.4 .2. データセンターの更新
name、d escri pti o n、sto rag e_type、versi o n、sto rag e_fo rmat の各要素は、作成後に更新が
可能です。
例9 .4 データセンターの更新
PUT /api/datacenters/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<data_center>
<name>UpdatedName</name>
<description>An updated description for the data
center</description>
</data_center>
9.4 .3. データセンターの削除
データセンターを削除するには、D ELET E 要求を実行する必要があります。
例9 .5 データセンターの削除
DELETE /api/datacenters/00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
9.5. サブコレクション
9.5.1. ストレージドメインのサブコレクション
9 .5 .1 .1 . ストレージドメインのサブコレクション
各データセンターには、アタッチされたストレージドメイン用のサブコレクションが含まれます。API ユー
ザーは、標準の REST メソッドでこのサブコレクションとの対話を行ってください。
アタッチされたストレージドメインには、最上位のストレージドメインと同様の表現が記載されています。
ただし、データセンター固有の status およびアクションセットが記載されている点が異なりま
す。status 要素の状態は、capabi l i ti es の下の sto rag e_d o mai n_states に記載されています。
66
⁠第9 章 データセンター
重要
API は、本セクションに記載した時点では試験段階にあり、今後変更される可能性があるため、後方
互換性に関する記載内容は適用されません。
9 .5 .1 .2 . ストレージドメインのアタッチとデタッチ
データセンターは、ストレージドメインを少なくとも 1 つアタッチしなければ使用できる状態になりませ
ん。ストレージドメインをアタッチするには、API ユーザーが データセンターストレージドメインのサブコ
レクションを P O ST してください。
ストレージドメインをアタッチする際には、i d または name を指定する必要があります。ストレージドメ
インをデータセンターにアタッチする例は以下のとおりです。
例9 .6 データセンターへのストレージドメインのアタッチ
POST /api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"/>
HTTP/1.1 201 Created
Location: /datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed
Content-Type: application/xml
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"
href="/api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/
fabe0451-701f-4235-8f7e-e20e458819ed">
<name>images0</name>
<type>data</type>
<status>
<state>inactive</state>
</status>
<master>true</master>
<storage>
<type>nfs</type>
<address>172.31.0.6</address>
<path>/exports/RHEVX/images/0</path>
</storage>
<data_center id="d70d5e2d-b8ad-494a-a4d2-c7a5631073c4"
href="/api/datacenters/d70d5e2d-b8ad-494a-a4d2-c7a5631073c4"/>
<actions>
<link rel="activate"
href="/api/datacenters/d70d5e2d-b8ad-494a-a4d2-c7a5631073c4/
storagedomains/fabe0451-701f-4235-8f7ee20e458819ed/activate"/>
<link rel="deactivate"
href="/api/datacenters/d70d5e2d-b8ad-494a-a4d2-c7a5631073c4/
67
REST API ガイド
storagedomains/fabe0451-701f-4235-8f7ee20e458819ed/deactivate"/>
</actions>
</storage_domain>
データセンターからストレージドメインをデタッチするには、D ELET E 要求を使用します。この要求を非
同期とするには、オプションの async 要素を記載してください。
例9 .7 データセンターからのストレージドメインのデタッチ
DELETE /api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<async>true</async>
</action>
9 .5 .1 .3. アクション
9 .5.1.3.1. ストレージドメインをアクティブ化するアクション
アタッチされているストレージドメインを使用するには、データセンター上であらかじめアクティブ化して
おく必要があります。アクティブ化のアクションには、アクション固有のパラメーターを取る必要はありま
せん。
例9 .8 データセンター上でストレージドメインをアクティブ化するためのアクション
POST /api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/fabe0451-701f-4235-8f7ee20e458819ed/activate HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
9 .5.1.3.2. ストレージドメインを非アクティブ化するアクション
アタッチされているストレージドメインを削除する前には、データセンター上で非アクティブ化してくださ
い。非アクティブ化のアクションは、アクション固有のパラメーターは取りません。
例9 .9 データセンター上でストレージドメインを非アクティブ化するためのアクション
POST /api/datacenters/d70d5e2d-b8ad-494a-a4d2c7a5631073c4/storagedomains/fabe0451-701f-4235-8f7ee20e458819ed/deactivate HTTP/1.1
Accept: application/xml
68
⁠第9 章 データセンター
Content-type: application/xml
<action/>
9.5.2. ネットワークのサブコレクション
9 .5 .2 .1 . ネットワークのサブコレクション
データセンターに関連付けられるネットワークは、netwo rks サブコレクションで表現します。データセ
ンターの netwo rk サブコレクションには以下の要素が含まれています。
表9 .2 ネットワークの要素
要素
タイプ
説明
name
文字列
d escri pti o n
文字列
rel = "permi ssi o ns"
リレーションシップ
rel = "vni cpro fi l es"
リレーションシップ
rel = "l abel s"
リレーションシップ
d ata_center i d =
リレーションシップ
stp
ブール値: true または false
mtu
整数
usag es
複合
プレーンテキスト形式の人間が判読できる
ネットワーク名
プレーンテキスト形式の人間が判読できる
ネットワークの説明
ネットワークの permi ssi o ns サブコレ
クションへのリンク
ネットワークの vni cpro fi l es サブコレ
クションへのリンク
ネットワークの l abel s サブコレクショ
ンへのリンク
ネットワークが属するデータセンターへの
参照
ネットワークに対してスパニングツリープ
ロトコルを有効にするかどうかを指定しま
す。
ネットワークの最大転送単位を指定しま
す。
ネットワークの usag e 要素セットを定義
します。ユーザーはこのレベルでネット
ワークを vm および d i spl ay ネットワー
クとして定義できます。
REST API では、標準の REST メソッドで netwo rks サブコレクションを操作することができます。たと
えば P O ST メソッドを使用して、ネットワークの i d や name を更新することができます。
例9 .10 ネットワークリソースとデータセンターの関連付け
POST /api/datacenters/00000000-0000-0000-0000-000000000000/networks
HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<network id="da05ac09-00be-45a1-b0b5-4a6a2438665f">
<name>ovirtmgmt</name>
</network>
HTTP/1.1 201 Created
69
REST API ガイド
Location: http://{host}/clusters/00000000-0000-0000-0000000000000000/networks/00000000-0000-0000-0000-000000000000
Content-Type: application/xml
<network href="/api/networks/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000">
<name>Network_001</name>
<link href="/api/networks/00000000-0000-0000-0000000000000000/permissions"
rel="permissions"/>
<link href="/api/networks/00000000-0000-0000-0000000000000000/vnicprofiles"
rel="vnicprofiles"/>
<link href="/api/networks/00000000-0000-0000-0000000000000000/labels"
rel="labels"/>
<data_center href="/api/datacenters/00000000-0000-0000-0000000000000000"
id="00000000-0000-0000-0000-000000000000"/>
<stp>false</stp>
<mtu>0</mtu>
<usages>
<usage>vm</usage>
</usages>
</network>
P UT 要求でリソースを更新します。ネットワークの最大伝送単位は、mtu 要素の整数値を指定する P UT 要
求を使用して設定されます。
例9 .11 ネットワークの最大伝送単位の設定
PUT /api/datacenters/00000000-0000-0000-0000000000000000/networks/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<network>
<mtu>1500</mtu>
</network>
関連付けは、コレクション内の該当する要素に対する D ELET E 要求で削除します。
例9 .12 データセンターからのネットワークの関連付けの削除
DELETE /api/datacenters/00000000-0000-0000-0000000000000000/networks/00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
9.5.3. クォータのサブコレクション
70
⁠第9 章 データセンター
9 .5 .3.1 . クォータのサブコレクション
クォータのサブコレクションには、Red Hat Enterprise Virtualization Manager がリソースに対して課す
制限が記載されています。API ユーザーは、G ET メソッドを使用して、このサブコレクションとリソース
を表示します。
例9 .13 クォータの XML 表現
<quota href="/api/datacenters/56087282-d7a6-11e1-af44-001a4a400e0c
/quotas/e13ff85a-b2ba-4f7b-8010-e0d057c03dfe"
id="e13ff85a-b2ba-4f7b-8010-e0d057c03dfe">
<name>MyQuota</name>
<description>A quota for my Red Hat Enterprise
Virtualization environment</description>
<data_center href= "/api/datacenters/56087282-d7a6-11e1-af44001a4a400e0c"
id="56087282-d7a6-11e1-af44-001a4a400e0c"/>
</quota>
新規クォータの作成には name および d escri pti o n 要素が必要です。
例9 .14 クォータの作成
POST /api/datacenters/56087282-d7a6-11e1-af44-001a4a400e0c/quotas
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<quota>
<name>VMQuota</name>
<description>My new quota for virtual machines</description>
</quota>
クォータを削除する場合は D ELET E 要求が必要になります。
例9 .15 クォータの削除
DELETE /api/datacenters/01a45ff0-915a-11e0-8b875254004ac988/quotas/e13ff85a-b2ba-4f7b-8010-e0d057c03dfe HTTP/1.1
HTTP/1.1 204 No Content
9.6. アクション
9.6.1. データセンターの強制削除のアクション
71
REST API ガイド
マスターストレージドメインへの接続が切断されたり、ストレージドメインを削除する際にホストが不足し
ているなど、ストレージドメインに解決不可能な問題が発生した場合には、データセンターを強制削除して
ください。このような状況に対応するために、API には fo rce アクションが実装されています。
このアクションにより、API が Red Hat Enterprise Virtualization 環境から選択したデータセンターを削除
する前に、そのデータセンターに関連付けられたデータベースエントリーが削除されます。これは、関連付
けられているストレージドメインに関わらず、API がデータセンターを削除することを意味します。
このアクションには D ELET E メソッドが必要です。この要求の本文には、acti o n 表現を記載し、fo rce
パラメーターを true に設定します。またこの要求には、XML 表現を処理するための追加のC o ntenttype: appl i cati o n/xml ヘッダーも本文に記載する必要があります。
例9 .16 データセンター上での強制削除アクション
DELETE /api/datacenters/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<force>true</force>
</action>
このアクションは、以下の操作を実行します。
データセンターに関連付けられている d ata ストレージドメインのデータベース情報をすべて削除しま
す。
データセンターに関連付けられている d ata ストレージドメイン上にある仮想マシンやテンプレートな
どのリソースのデータベース情報をすべて削除します。
データセンターから i so ストレージドメインおよび expo rt ストレージドメインをデタッチします。
データセンターのデータベース情報を削除します。
このアクションは、データセンターを空にしてからでないと削除できないという要件よりも優先されます。
重要
このアクションは、対象となるデータセンターに関連付けられたリソースのデータベースエントリー
のみを削除します。データセンターに関連付けられた d ata ストレージドメインは、再度使用する前
に手動でフォーマットする必要があります。また i so ドメインおよび expo rt ドメインのメタデー
タは、他のデータセンターで使用する前に手動でクリーニングしておく必要があります。
72
⁠第1 0 章 クラスター
第10章 クラスター
10.1. クラスターの要素
cl usters コレクションは、Red Hat Enterprise Virtualization 環境内のクラスターに関する情報を提供し
ます。API ユーザーは、エントリーポイント URI から取得した rel = "cl usters" リンクでこの情報にア
クセスします。
以下の表には、クラスタリソースの表現に含まれる特定の要素をまとめています。
表10.1 クラスターの要素
要素
タイプ
説明
name
文字列
d escri pti o n
文字列
l i nk
rel = "netwo rks"
リレーションシップ
l i nk
rel = "permi ssi o ns"
l i nk
rel = "g l ustervo l um
es"
l i nk
rel = "g l usterho o ks
"
l i nk
rel = "affi ni tyg ro u
ps"
cpu i d =
リレーションシップ
d ata_center i d =
GUID
ユーザーによって提供される、人間が
判読できるクラスター名。name はそ
のタイプの全クラスターリソースで一
意です。
ユーザーによって提供される、人間が
判読できる自由形式のクラスターの説
明
そのクラスターに関連付けられたネッ
トワークのサブコレクションへのリン
ク
クラスターパーミッションのサブコレ
クションへのリンク
このクラスターに関連付けられた Red
Hat Gluster Storage ボリュームのサ
ブコレクションへのリンク
そのクラスターに関連付けられた Red
Hat Gluster Storage ボリュームフッ
クのサブコレクションへのリンク
そのクラスターに関連付けられた仮想
マシンのアフィニティーグループのサ
ブコレクションへのリンク
クラスター内で全ホストがサポートす
る必要のある CPU タイプを定義する
サーバーの CPU 参照
そのクラスターのデータセンターメン
バーシップへの参照
memo ry_po l i cy
複合型
ホストのメモリー使用に関するクラス
ターのポリシーを定義します。
sched ul i ng _po l i c
y
複合型
versi o n majo r=
mi no r=
複合型
クラスター内のホストの負荷分散また
はパワーセービングのモードを定義し
ます。
クラスターの互換性レベル
suppo rted _versi o n
s
複合型
リレーションシップ
リレーションシップ
リレーションシップ
複合型
プロパ
ティー
クラスターに設定可能な versi o n レ
ベルの一覧
73
REST API ガイド
要素
タイプ
説明
erro r_hand l i ng
複合型/列挙型
vi rt_servi ce
ブール値
g l uster_servi ce
ブール値
thread s_as_co res
ブール値
tunnel _mi g rati o n
ブール値
trusted _servi ce
ブール値
bal l o o ni ng _enabl
ed
ksm
ブール値
クラスター内のホストが非稼働状態に
なった場合の仮想マシンの処理を定義
します。capabi l i ti es 内に記載さ
れている列挙型のプロパティーを含む
o n_erro r 要素が 1 つ必要です。
そのクラスターの仮想化サービスを公
開するかどうかを定義します。
このクラスターの Red Hat Gluster
Storage サービスを公開するかどうか
を定義します。
プロセッサーコア合計数がホストのコ
ア数を上回る場合に、ホストが仮想マ
シンを実行できるかどうかを定義しま
す。
仮想マシンが移行中に libvirt/libvirt 間
のトンネルを使用するかどうかを定義
します。
ホストの検証に OpenAttestation サー
バーを使用するかどうかを定義しま
す。
クラスターでバルーニングを有効化す
るかどうかを定義します。
クラスターで ksm を有効化するかど
うかを定義します。
ブール値
プロパ
ティー
注記
ホストの 空きメモリーが 20% 未満に下がると、mo m. C o ntro l l ers. Bal l o o n - INFO
Bal l o o ni ng g uest: hal f1 fro m 10 9 6 4 0 0 to 19 9 1580 のようなバルーニングコマンド
が /etc/vd sm/mo m. co nf にログ記録されます。/etc/vd sm/mo m. co nf は、Memory
Overcommit Manager のログファイルです。イベントは、仮想マシンがバルーンを優先しない場合
にも、イベントログに追加されます。
10.2. memory_policy 要素
memo ry_po l i cy 要素には次のような要素が含まれます。
表10.2 memo ry_p o licy 要素
要素
74
タイプ
説明
プロパ
ティー
⁠第1 0 章 クラスター
要素
タイプ
説明
o verco mmi t percent=
複合型
transparent_hug epag es
複合型
許容されるホストのメモリー使用率。
この値を超えると、そのホスト上では
仮想マシンをそれ以上起動できなくな
ります。KSM を使用する環境では、
メモリー共有により、仮想マシンは使
用可能なホストメモリーを超える容量
を使用することができます。推奨値に
は 10 0 (なし)、150 (サーバーの負
荷)、および 20 0 (デスクトップの負
荷) が含まれます。
Transparent Hugepage の
enabl ed ステータスを定義します。
ステータスは true または false のいず
れかです。capabi l i ti es 機能
セットをチェックして、ご使用のバー
ジョンが transparent
hug epag es をサポートしていること
を確認してください。
プロパ
ティー
10.3. スケジューリングポリシーの要素
sched ul i ng _po l i cy 要素には次のような要素が含まれます。
表10.3 スケジューリングポリシーの要素
要素
タイプ
説明
po l i cy
列挙型
thresho l d s l o w=
hi g h= d urati o n=
複合型
クラスター内のホストの仮想マシンス
ケジューリングモード。列挙型の一覧
は capabi l i ti es に記載されてい
ます。
ホストの CPU 制限値を定義しま
す。hi g h 属性は、ホストに許容され
る最大 CPU 使用率を制御し、この値
を上回ると過負荷とみなされま
す。l o w 属性は、ホストに許容され
る最小 CPU 使用率を制御し、この値
を下回ると使用率が低い状態とみなさ
れます。d urati o n 属性は、ホスト
が過負荷の状態で経過する必要のある
秒数を示し、この値を超えると、スケ
ジューラーが起動して負荷を別のホス
トに移します。
プロパ
ティー
10.4 . クラスターの XML 表現
例10.1 クラスターの XML 表現
<cluster id="00000000-0000-0000-0000-000000000000"
75
REST API ガイド
href="/api/clusters/00000000-0000-0000-0000-000000000000">
<name>Default</name>
<description>The default server cluster</description>
<link rel="networks"
href="/api/clusters/00000000-0000-0000-0000000000000000/networks"/>
<link rel="permissions"
href="/api/clusters/00000000-0000-0000-0000000000000000/permissions"/>
<link rel="glustervolumes"
href="/api/clusters/00000000-0000-0000-0000000000000000/glustervolumes"/>
<link rel="glusterhooks"
href="/api/clusters/00000000-0000-0000-0000000000000000/glusterhooks"/>
<link rel="affinitygroups"
href="/api/clusters/00000000-0000-0000-0000000000000000/affinitygroups"/>
<cpu id="Intel Penryn Family"/>
<architecture>X86_64<architecture/>
<data_center id="00000000-0000-0000-0000-000000000000"
href="/api/datacenters/00000000-0000-0000-0000-000000000000"/>
<memory_policy>
<overcommit percent="100"/>
<transparent_hugepages>
<enabled>false</enabled>
</transparent_hugepages>
</memory_policy>
<scheduling_policies>
<policy>evenly_distributed</policy>
<thresholds low="10" high="75" duration="120"/>
</scheduling_policies>
<version minor="0" major="3"/>
<supported_versions>
<version minor="0"<usage> major="3"/>
</supported_versions>
<error_handling>
<on_error>migrate</on_error>
</error_handling>
<virt_service>true</virt_service>
<gluster_service>false</gluster_service>
<threads_as_cores>false</threads_as_cores>
<tunnel_migration>false</tunnel_migration>
<trusted_service>false</trusted_service>
<ha_reservation>false</ha_reservation>
<ballooning_enabled>false</ballooning_enabled>
<ksm>
<enabled>true</enabled>
</ksm>
</cluster>
10.5. クラスターの JSON 表現
76
⁠第1 0 章 クラスター
例10.2 クラスターの JSO N 表現
{
"cluster" : [ {
"cpu" : {
"architecture" : "X86_64",
"id" : "Intel Penryn Family"
},
"data_center" : {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255",
"id" : "00000002-0002-0002-0002-000000000255"
},
"memory_policy" : {
"overcommit" : {
"percent" : "100"
},
"transparent_hugepages" : {
"enabled" : "true"
}
},
"scheduling_policy" : {
"policy" : "none",
"name" : "none",
"href" : "/api/schedulingpolicies/b4ed2332-a7ac-4d5f-959699a439cb2812",
"id" : "b4ed2332-a7ac-4d5f-9596-99a439cb2812"
},
"version" : {
"major" : "3",
"minor" : "5"
},
"error_handling" : {
"on_error" : "migrate"
},
"virt_service" : "true",
"gluster_service" : "false",
"threads_as_cores" : "false",
"tunnel_migration" : "false",
"trusted_service" : "false",
"ha_reservation" : "false",
"optional_reason" : "false",
"ballooning_enabled" : "false",
"ksm" : {
"enabled" : "true"
},
"required_rng_sources" : { },
"name" : "Default",
"description" : "The default server cluster",
"href" : "/api/clusters/00000001-0001-0001-0001-0000000002fb",
"id" : "00000001-0001-0001-0001-0000000002fb",
"link" : [ {
"href" : "/api/clusters/00000001-0001-0001-00010000000002fb/networks",
"rel" : "networks"
77
REST API ガイド
}, {
"href" : "/api/clusters/00000001-0001-0001-00010000000002fb/permissions",
"rel" : "permissions"
}, {
"href" : "/api/clusters/00000001-0001-0001-00010000000002fb/glustervolumes",
"rel" : "glustervolumes"
}, {
"href" : "/api/clusters/00000001-0001-0001-00010000000002fb/glusterhooks",
"rel" : "glusterhooks"
}, {
"href" : "/api/clusters/00000001-0001-0001-00010000000002fb/affinitygroups",
"rel" : "affinitygroups"
}, {
"href" : "/api/clusters/00000001-0001-0001-00010000000002fb/cpuprofiles",
"rel" : "cpuprofiles"
} ]
} ]
}
10.6. メソッド
10.6.1. クラスターの作成
新規クラスターの作成には、name、cpu i d = 、および d atacenter の各要素が必要です。d atacenter
は i d 属性または name 要素で特定します。
例10.3 クラスターの作成
POST /api/clusters HTTP/1.1
Accept: application/xml
Content-type: application/xml
<cluster>
<name>cluster1</name>
<cpu id="Intel Penryn Family"/>
<data_center id="00000000-0000-0000-0000-000000000000"/>
</cluster>
10.6.2. クラスターの更新
name、d escri pti o n、cpu i d = 、erro r_hand l i ng の各要素は、作成後に更新が可能です。
例10.4 クラスターの更新
78
⁠第1 0 章 クラスター
PUT /api/clusters/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<cluster>
<description>Cluster 1</description>
</cluster>
10.6.3. クラスターの削除
クラスターを削除するには D ELET E 要求を実行する必要があります。
例10.5 クラスターの削除
DELETE /api/clusters/00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
10.7. サブコレクション
10.7.1. ネットワークのサブコレクション
1 0 .7 .1 .1 . ネットワークのサブコレクション
クラスターに関連付けられるネットワークは netwo rks サブコレクションで表現します。1 クラスター内
のホストはすべて、これらの関連付けられたネットワークに接続します。
クラスターの netwo rk サブコレクションの表現は、以下の追加要素を除いては、標準のnetwo rk リソー
スと同じです。
表10.4 追加のネットワーク要素
要素
タイプ
説明
cl uster i d =
リレーションシップ
req ui red
ブール値
d i spl ay
ブール値
usag es
複合型
ネットワークがメンバーとなっている
クラスターへの参照
必須または任意のネットワークステー
タスを定義します。
表示ネットワークステータスを定義し
ます。後方互換性を維持するために使
用されます。
ネットワークの usag e 要素セットを
定義します。ユーザーはこのレベルで
ネットワークを VM および D ISP LAY
ネットワークとして定義できます。
プロパ
ティー
API ユーザーは、標準の REST メソッドを使用して netwo rks サブコレクションを操作します。ネット
ワーク i d または name の参照を netwo rks サブコレクションに P O ST することにより、そのネットワー
クはクラスターに関連付けられます。
79
REST API ガイド
例10.6 クラスターへのネットワークリソースの関連付け
POST /api/clusters/99408929-82cf-4dc7-a532-9d998063fa95/networks
HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<network id="da05ac09-00be-45a1-b0b5-4a6a2438665f">
<name>ovirtmgmt</name>
</network>
HTTP/1.1 201 Created
Location: http://{host}/clusters/99408929-82cf-4dc7-a5329d998063fa95/networks/da05ac09-00be-45a1-b0b5-4a6a2438665f
Content-Type: application/xml
<network id="da05ac09-00be-45a1-b0b5-4a6a2438665f"
href="/api/clusters/99408929-82cf-4dc7-a532-9d998063fa95/networks/
da05ac09-00be-45a1-b0b5-4a6a2438665f">
<name>ovirtmgmt</name>
<status>
<state>operational</state>
</status>
<description>Display Network</description>
<cluster id="99408929-82cf-4dc7-a532-9d998063fa95"
href="/api/clusters/99408929-82cf-4dc7-a532-9d998063fa95"/>
<data_center id="d70d5e2d-b8ad-494a-a4d2-c7a5631073c4"
href="/api/datacenters/d70d5e2d-b8ad-494a-a4d2-c7a5631073c4"/>
<required>true</required>
<usages>
<usage>VM</usage>
</usages>
</network>
P UT 要求を使用してリソースを更新します。
例10.7 ディスプレイネットワークステータスの設定
PUT /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/networks/da05ac09-00be-45a1-b0b5-4a6a2438665f HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<network>
<required>false</required>
<usages>
<usage>VM</usage>
<usage>DISPLAY</usage>
</usages>
</network>
80
⁠第1 0 章 クラスター
P UT 要求を使用して必須または任意のネットワークステータスを設定し、req ui red 要素のブール値
(true または false) を指定します。
例10.8 任意ネットワークステータスの設定
PUT /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/networks/da05ac09-00be-45a1-b0b5-4a6a2438665f HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<network>
<required>false</required>
</network>
関連付けは、コレクション内の該当する要素に対する D ELET E 要求で削除します。
例10.9 クラスターからのネットワーク関連付けの削除
DELETE /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/networks/da05ac09-00be-45a1-b0b5-4a6a2438665f HTTP/1.1
HTTP/1.1 204 No Content
10.7.2. ストレージボリュームのサブコレクション
1 0 .7 .2 .1 . Re d Hat Glust e r St o rage ボリュームのサブコレクション
Red Hat Enterprise Virtualization では、Red Hat Gluster Storage ボリュームを作成および管理できま
す。Red Hat Gluster Storage ボリュームは、クラスターに関連付けられ、g l ustervo l umes サブコレ
クションで表されます。
g l ustervo l umes サブコレクション内の Red Hat Gluster Storage ボリュームリソースの表現は、以下
の要素を使用して定義されます。
表10.5 G lu st er ボリュームの要素
要素
タイプ
説明
vo l ume_type
列挙型
ボリュームタイプを定義します。ボ
リュームタイプのリストについて
は、capabi l i ti es コレクション
を参照してください。
プロパ
ティー
81
REST API ガイド
要素
タイプ
説明
bri cks
リレーションシップ
transpo rt_types
複合型
repl i ca_co unt
整数
Red Hat Gluster Storage ブリックの
サブコレクションです。新規ボリュー
ムを作成する場合は、このクラスター
で作成および管理するために bri ck
要素のセットが要求で必要です。Red
Hat Gluster Storage サーバーの
server_i d およびブリックディレク
トリーの bri ck_d i r 要素が必要と
なります。
ボリューム transpo rt_type 要素の
セットを定義します。利用可能なトラ
ンスポートタイプのリストについて
は、capabi l i ti es コレクション
を参照してください。
複製ボリュームのファイルレプリケー
ション数を定義します。
stri pe_co unt
整数
ストライプボリュームのストライプ数
を定義します。
o pti o ns
複合型
追加の Red Hat Gluster Storage
o pti o n 要素のセットです。各
o pti o n には、オプションの name
と val ue が含まれます。
プロパ
ティー
例10.10 R ed H at G lu st er St o rag e ボリュームの XML 表現
<gluster_volume id="99408929-82cf-4dc7-a532-9d998063fa95"
href="/api/clusters/99408929-82cf-4dc7-a532-9d998063fa95
/glustervolume/e199f877-900a-4e30-8114-8e3177f47651">
<name>GlusterVolume1</name>
<link rel="bricks"
href="/api/clusters/99408929-82cf-4dc7-a532-9d998063fa95
/glustervolume/e199f877-900a-4e30-8114-8e3177f47651/bricks"/>
<volume_type>DISTRIBUTED_REPLICATE</volume_type>
<transport_types>
<transport_type>TCP</transport_type>
</transport_types>
<replica_count>2</replica_count>
<stripe_count>1</stripe_count>
<options>
<option>
<name>cluster.min-free-disk</name>
<value>536870912</value>
</option>
</options>
</gluster_volume>
P O ST 要求で必要な name、vo l ume_type、および bri cks をサブコレクションに送信して Red Hat
Gluster Storage ボリュームを作成します。
例10.11 R ed H at G lu st er St o rag e ボリュームの作成
82
⁠第1 0 章 クラスター
POST /api/clusters/99408929-82cf-4dc7-a532-9d998063fa95/glustervolumes
HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<gluster_volume>
<name>GlusterVolume1</name>
<volume_type>DISTRIBUTED_REPLICATE</volume_type>
<bricks>
<brick>
<server_id>server1</server_id>
<brick_dir>/exp1</brick_dir>
</brick>
<bricks>
</gluster_volume>
D ELET E 要求を使用して Red Hat Gluster Storage ボリュームを削除します。
例10.12 R ed H at G lu st er St o rag e ボリュームの削除
DELETE /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/glustervolumes/e199f877-900a-4e30-8114-8e3177f47651
HTTP/1.1
HTTP/1.1 204 No Content
重要
g l ustervo l umes サブコレクション内のリソースは更新できません。
1 0 .7 .2 .2 . ブリックサブコレクション
g l ustervo l umes サブコレクションには、独自の bri cks サブコレクションが格納されおり、Red Hat
Gluster Storage ボリューム内の個々のブリックを定義します。G ET 要求に関する追加の情報は、Al l C o ntent: true ヘッダーを使用して取得することができます。
ボリュームの bri cks サブコレクションの表現は、以下の要素を使用して定義されます。
表10.6 ブリックの要素
要素
タイプ
説明
server_i d
文字列
Red Hat Gluster Storage サーバーへ
の参照
bri ck_d i r
文字列
Red Hat Gluster Storage サーバーの
ブリックディレクトリーを定義しま
す。
プロパ
ティー
83
REST API ガイド
要素
タイプ
説明
repl i ca_co unt
整数
ボリューム内のブリックのファイル
レプリケーション数を定義します。
stri pe_co unt
整数
ボリューム内のブリックのストライプ
数を定義します。
プロパ
ティー
P O ST 要求で必要な server_i d および bri ck_d i r をサブコレクションに対して送信して新規ブリック
を作成します。
例10.13 ブリックの追加
POST /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/glustervolumes/e199f877-900a-4e30-8114-8e3177f47651/bricks
HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<brick>
<server_id>server1</server_id>
<brick_dir>/exp1</brick_dir>
</brick>
D ELET E 要求でブリックを削除します。
例10.14 ブリックの削除
DELETE /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/glustervolumes/e199f877-900a-4e30-81148e3177f47651/bricks/0a473ebe-01d2-444d-8f58-f565a436b8eb HTTP/1.1
HTTP/1.1 204 No Content
重要
bri cks サブコレクション内のリソースは更新できません。
1 0 .7 .2 .3. アクション
10.7.2.3.1. st art アクション
start アクションは、Gluster ボリュームを使用できる状態にします。
例10.15 ボリュームの起動
POST /api/clusters/99408929-82cf-4dc7-a532-
84
⁠第1 0 章 クラスター
9d998063fa95/glustervolumes/e199f877-900a-4e30-8114-8e3177f47651/start
HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<action/>
オプションの fo rce ブール値要素を使用して、稼働しているボリュームに対して操作を強制的に実行しま
す。これは、稼働しているボリュームで無効なブリックプロセスを開始する場合に役に立ちます。
10.7.2.3.2. st o p アクション
sto p アクションは Gluster ボリュームを非アクティブ化します。
例10.16 ボリュームの停止
POST /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/glustervolumes/e199f877-900a-4e30-8114-8e3177f47651/stop
HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<action/>
stop アクションを強制するには、オプションの fo rce ブール要素を使用します。
10.7.2.3.3. set O p t io n アクション
setO pti o n アクションは、ボリュームのオプションを設定します。
例10.17 オプションの設定
POST /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/glustervolumes/e199f877-900a-4e30-81148e3177f47651/setoption HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<action>
<option>
<name>cluster.min-free-disk</name>
<value>536870912</value>
</option>
</action>
10.7.2.3.4 . reset O p t io n アクション
resetO pti o n アクションは、ボリュームのオプションをリセットします。
例10.18 オプションのリセット
85
REST API ガイド
POST /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/glustervolumes/e199f877-900a-4e30-81148e3177f47651/resetoption HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<action>
<option>
<name>cluster.min-free-disk</name>
</option>
</action>
10.7.2.3.5. reset AllO p t io n s アクション
resetAl l O pti o ns アクションは、ボリュームの全オプションをリセットします。
例10.19 全オプションのリセット
POST /api/clusters/99408929-82cf-4dc7-a5329d998063fa95/glustervolumes/e199f877-900a-4e30-81148e3177f47651/resetalloptions HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<action/>
10.7.3. アフィニティーグループのサブコレクション
1 0 .7 .3.1 . アフィニティーグループのサブコレクション
affi ni tyg ro ups サブコレクション内の仮想マシンアフィニティーグループリソースの表現は、以下の
要素を使用して定義されます。
表10.7 アフィニティーグループの要素
要素
タイプ
説明
name
文字列
プレーンテキスト形式の人間が判読で
きるアフィニティーグループ名
cl uster
リレーションシップ
po si ti ve
ブール値: true または
false
アフィニティーグループの適用先のク
ラスターへの参照
アフィニティーグループがアフィニ
ティーグループに所属する仮想マシン
に対して、ポジティブ、ネガティブい
ずれのアフィニティーを適用するか指
定します。
86
プロパ
ティー
⁠第1 0 章 クラスター
要素
タイプ
説明
enfo rci ng
ブール値: true または
false
アフィニティーグループにおけるア
フィニティーの強制で、アフィニ
ティーグループに所属する仮想マシン
に適用する際にハードまたはソフトの
いずれを使用するかを指定します。
プロパ
ティー
例10.20 仮想マシンのアフィニティーグループの XML 表現
<affinity_group href="/api/clusters/00000000-0000-0000-0000000000000000/affinitygroups/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000">
<name>AF_GROUP_001</name>
<cluster href="/api/clusters/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000"/>
<positive>true</positive>
<enforcing>true</enforcing>
</affinity_group>
必要な name 属性を指定して P O ST 要求を使用して仮想マシンのアフィニティーグループを作成します。
例10.21 仮想マシンのアフィニティーグループの作成
POST https://XX.XX.XX.XX/api/clusters/00000000-0000-0000-0000000000000000/affinitygroups HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<affinity_group>
<name>AF_GROUP_001</name>
<positive>true</positive>
<enforcing>true</enforcing>
</affinity_group>
D ELET E 要求で仮想マシンのアフィニティーグループを削除します。
例10.22 仮想マシンのアフィニティーグループの削除
DELETE https://XX.XX.XX.XX/api/clusters/00000000-0000-0000-0000000000000000/affinitygroups/00000000-0000-0000-0000-000000000000
HTTP/1.1
HTTP/1.1 204 No Content
87
REST API ガイド
第11章 ネットワーク
11.1. ネットワークの要素
netwo rks コレクションは、Red Hat Enterprise Virtualization 環境内の論理ネットワークに関する情報を
提供します。API ユーザーは、エントリーポイント URL から取得した rel = "netwo rks" リンクでこの情
報にアクセスします。
以下の表には、ネットワークリソースの表現に含まれる特定の要素をまとめています。
表11.1 ネットワークの要素
要素
タイプ
説明
l i nk
rel = "vni cpro fi l e
s"
l i nk
rel = "l abel s"
リレーションシップ
d ata_center i d =
GUID
その論理ネットワークにアタッチされ
ている VNIC プロファイルのサブコレ
クションへのリンク
その論理ネットワークにアタッチされ
ているラベルのサブコレクションへの
リンク
そのクラスターが属するデータセン
ターへの参照
vl an i d =
stp
整数
ブール値: true または
false
mtu
整数
status
o perati o nal または
no n_o perati o nal
usag es
複合型
リレーションシップ
プロパ
ティー
VLAN タグ
そのネットワークで Spanning Tree
Protocol を有効にする場合は true
に設定します。
論理ネットワークの最大転送単位を指
定します。この値が記載されていない
場合には、論理ネットワークはデフォ
ルト値を使用します。
ネットワークのステータス。これらの
ステータスは、capabi l i ti es の下
の netwo rk_states に記載されてい
ます。
ネットワークの usag e 要素セットを
定義します。ユーザーはこのレベルで
ネットワークを VM ネットワークとし
て定義することが可能です。
重要
API は、本セクションに記載した時点では試験段階にあり、今後変更される可能性があるため、後方
互換性に関する記載内容は適用されません。
11.2. ネットワークリソースの XML 表現
例11.1 ネットワークリソースの XML 表現
88
⁠第1 1 章 ネットワーク
<network href="/api/networks/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000">
<name>ovirtmgmt</name>
<description>Management Network</description>
<link href="/api/networks/00000000-0000-0000-0000000000000000/permissions" rel="permissions"/>
<link href="/api/networks/00000000-0000-0000-0000000000000000/vnicprofiles" rel="vnicprofiles"/>
<link href="/api/networks/00000000-0000-0000-0000000000000000/labels" rel="labels"/>
<data_center href="/api/datacenters/00000000-0000-0000-0000000000000000"
id="00000000-0000-0000-0000-000000000000"/>
<stp>false</stp>
<mtu>0</mtu>
<usages>
<usage>vm</usage>
</usages>
</network>
11.3. ネットワークリソースの JSON 表現
例11.2 ネットワークリソースの JSO N 表現
{
"network" : [ {
"data_center" : {
"href" : "/api/datacenters/00000002-0002-0002-0002000000000255",
"id" : "00000002-0002-0002-0002-000000000255"
},
"stp" : "false",
"mtu" : "0",
"usages" : {
"usage" : [ "vm" ]
},
"name" : "ovirtmgmt",
"description" : "Management Network",
"href" : "/api/networks/00000000-0000-0000-0000-000000000009",
"id" : "00000000-0000-0000-0000-000000000009",
"link" : [ {
"href" : "/api/networks/00000000-0000-0000-0000000000000009/permissions",
"rel" : "permissions"
}, {
"href" : "/api/networks/00000000-0000-0000-0000000000000009/vnicprofiles",
"rel" : "vnicprofiles"
}, {
"href" : "/api/networks/00000000-0000-0000-0000000000000009/labels",
89
REST API ガイド
"rel" : "labels"
} ]
} ]
}
11.4 . メソッド
11.4 .1. ネットワークリソースの作成
新規ネットワークの作成には name および d atacenter 要素が必要です。
例11.3 ネットワークリソースの作成
POST /api/networks HTTP/1.1
Accept: application/xml
Content-type: application/xml
<network>
<name>network 1</name>
<data_center id="00000000-0000-0000-0000-000000000000"/>
</network>
11.4 .2. ネットワークリソースの更新
name、d escri pti o n、i p、vl an、stp、d i spl ay の各要素は、作成後に更新が可能です。
例11.4 ネットワークリソースの更新
PUT /api/networks/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<network>
<description>Network 1</description>
</network>
11.4 .3. ネットワークリソースの削除
ネットワークを削除するには D ELET E 要求を実行する必要があります。
例11.5 ネットワークの削除
DELETE /api/networks/00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
90
⁠第1 1 章 ネットワーク
11.5. サブコレクション
11.5.1. ネットワーク VNIC プロファイルのサブコレクション
VNIC (Virtual Network Interface Controller) プロファイル (別称: 仮想マシンインターフェースプロファイ
ル) は、ユーザーやグループに適用してネットワーク帯域幅を制限するためのカスタマイズされたプロファ
イルです。各 vni cpro fi l e には以下のような要素が含まれています。
表11.2 VN IC プロファイルの要素
要素
タイプ
説明
name
d escri pti o n
netwo rk
文字列
文字列
文字列
po rt_mi rro ri ng
ブール値: true また
は fal se
プロファイルの一意識別子
プレーンテキストで記述されたプロファイルの説明
プロファイルが適用される論理ネットワークの一意識別
子
デフォルトは fal se です。
例11.6 ネットワークの vn icp ro f ile サブコレクションの XML 表現
<vnic_profile href= "/api/vnicprofiles/f9c2f9f1-3ae2-4100-a9a5285ebb755c0d" id="f9c2f9f1-3ae2-4100-a9a5-285ebb755c0d">
<name>Peanuts</name>
<description>shelled</description>
<network href= "/api/networks/00000000-0000-0000-0000-000000000009"
id="00000000-0000-0000-0000-000000000009"/>
<port_mirroring>false</port_mirroring>
</vnic_profile>
</vnic_profiles>
11.5.2. ネットワークラベルのサブコレクション
ネットワークラベルはプレーンテキスト形式の人間が判読できるラベルで、物理ホストのネットワークイン
ターフェースと論理ネットワークを自動的に関連付けることができます。各 l abel には以下の要素が含ま
れています。
表11.3 ラベルの要素
要素
タイプ
説明
netwo rk
文字列
ラベルを付けるネットワークの href と i d です。
例11.7 ネットワークのラベルサブコレクションの XML 表現
<labels>
<label href="/api/networks/00000000-0000-0000-0000000000000000/labels/eth0" id="eth0">
<network href="/api/networks/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000"/>
</label>
</labels>
91
REST API ガイド
11.5.3. メソッド
1 1 .5 .3.1 . 論理ネットワークにラベルを付けるアクション
論理ネットワークにラベルをつけて、同じラベルを付けたホストのネットワークインターフェースと論理
ネットワークを自動的に関連付けることができます。
例11.8 論理ネットワークにラベルを付けるアクション
POST /api/networks/00000000-0000-0000-0000-000000000000/labels/
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<label id="Label_001" />
1 1 .5 .3.2 . 論理ネットワークからのラベルの削除
論理ネットワークからラベルを削除するには D ELET E 要求が必要です。
例11.9 論理ネットワークからのラベルの削除
DELETE /api/networks/00000000-0000-0000-0000000000000000/labels/[label_id] HTTP/1.1
HTTP/1.1 204 No Content
92
⁠第1 2 章 ストレージドメイン
第12章 ストレージドメイン
12.1. ストレージドメインの要素
sto rag ed o mai ns コレクションは、Red Hat Enterprise Virtualization 環境内のストレージドメインに
関する情報を提供します。API ユーザーは、エントリーポイント URL から取得した
rel = "sto rag ed o mai ns" リンクでこの情報にアクセスします。
以下の表には、ストレージドメインリソースの表現に含まれる特定の要素をまとめています。
表12.1 St o rag e d o main の要素
要素
タイプ
l i nk
リレーションシップ
rel = "permi ssi o ns"
l i nk rel = "fi l es" リレーションシップ
説明
プロパ
ティー
ストレージドメインパーミッションの
サブコレクションへのリンク
そのストレージドメインの fi l es サ
ブコレクションへのリンク
type が expo rt に設定されているス
トレージドメインの vms サブコレク
ションへのリンク
type が expo rt に設定されているス
トレージドメインの templ ates サブ
コレクションへのリンク
ストレージドメインのタイプ。列挙値
の一覧は capabi l i ti es に記載さ
れています。
外部システムおよびプラグインがレ
ポートするストレージドメインのヘル
スステータス。state 要素に
は、o k、i nfo 、warni ng 、erro r
または fai l ure の列挙値が含まれま
す。
そのストレージドメインがデータセン
ターのマスターストレージドメインと
なる場合は true です。
そのストレージドメインの初期化を行
うホストへの参照。このホストに対す
る制約は、指定された物理ストレージ
にアクセス可能であるという点以外は
ありません。
ストレージドメインの下層のストレー
ジについての記述
l i nk rel = "vms"
リレーションシップ
l i nk
rel = "templ ates"
リレーションシップ
type
列挙型
external _status
複合型/列挙型
master
ブール値: true または
false
ho st
複合型
sto rag e
複合型
avai l abl e
整数
空き領域 (バイト単位)
used
整数
使用済み領域 (バイト単位)
co mmi tted
整数
コミット済み領域 (バイト単位)
93
REST API ガイド
要素
タイプ
説明
sto rag e_fo rmat
列挙型
wi pe_after_d el ete
ブール値: true または
false
warni ng _l o w_spac
e_i nd i cato r
整数
cri ti cal _space_ac
ti o n_bl o cker
整数
ストレージドメインのストレージ
フォーマットについての記述。列挙値
の一覧は capabi l i ti es に記載さ
れています。
ストレージドメインで削除後にワイプ
オプションをデフォルト設定します。
このオプションは、ドメインの作成後
に編集することが可能ですが、その場
合にはすでに存在していたディスクの
「削除後にワイプ」プロパティーは変
更されません。
容量不足の警告オプションを設定する
パーセンテージ値。ストレージドメイ
ンの空き容量がこの値を下回ると、
ユーザーに警告のメッセージが表示さ
れ、ログに記録されます。
アクションをブロックする深刻な容量
不足オプションを設定する値 (GB 単
位)。ストレージドメインの空き容量
がこの値を下回ると、ユーザーにエ
ラーメッセージが表示され、ログに記
録されます。容量を消費する新規アク
ションは、一時的であってもすべてブ
ロックされます。
プロパ
ティー
重要
API は、本章に記載した時点では試験段階にあり、今後変更される可能性があるため、後方互換性に
関する記載内容は適用されません。
12.2. ストレージドメインの XML 表現
例12.1 ストレージドメインの XML 表現
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"
href="/api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed">
<name>data0</name>
<link rel="permissions"
href="/api/storagedomains/be24cd98-8e23-49c7-b4251a12bd12abb0/permissions"/>
<link rel="files"
href="/api/storagedomains/be24cd98-8e23-49c7-b4251a12bd12abb0/files"/>
<type>data</type>
<master>true</master>
<storage>
<type>nfs</type>
<address>172.31.0.6</address>
94
⁠第1 2 章 ストレージドメイン
<path>/exports/RHEVX/images/0</path>
</storage>
<available>156766306304</available>
<used>433791696896</used>
<committed>617401548800</committed>
<storage_format>v1</storage_format>
<wipe_after_delete>true</wipe_after_delete>
<warning_low_space_indicator>10</warning_low_space_indicator>
<critical_space_action_blocker>5</critical_space_action_blocker>
</storage_domain>
12.3. ストレージドメインの JSON 表現
例12.2 ストレージドメインの JSO N 表現
{
"storage_domain" : [ {
"type" : "data",
"master" : "false",
"storage" : {
"address" : "192.0.2.0",
"type" : "nfs",
"path" : "/storage/user/nfs"
},
"available" : 193273528320,
"used" : 17179869184,
"committed" : 0,
"storage_format" : "v3",
"name" : "NFS_01",
"href" : "/api/storagedomains/8827b158-6d2e-442d-a7eec6fd4718aaba",
"id" : "8827b158-6d2e-442d-a7ee-c6fd4718aaba",
"link" : [ {
"href" : "/api/storagedomains/8827b158-6d2e-442d-a7eec6fd4718aaba/permissions",
"rel" : "permissions"
}, {
"href" : "/api/storagedomains/8827b158-6d2e-442d-a7eec6fd4718aaba/disks",
"rel" : "disks"
}, {
"href" : "/api/storagedomains/8827b158-6d2e-442d-a7eec6fd4718aaba/storageconnections",
"rel" : "storageconnections"
}, {
"href" : "/api/storagedomains/8827b158-6d2e-442d-a7eec6fd4718aaba/disksnapshots",
"rel" : "disksnapshots"
}, {
"href" : "/api/storagedomains/8827b158-6d2e-442d-a7eec6fd4718aaba/diskprofiles",
95
REST API ガイド
"rel" : "diskprofiles"
} ]
} ]
}
12.4 . メソッド
12.4 .1. ストレージドメインの作成
新規のストレージドメインの作成には name、type、ho st、sto rag e の各要素が必要です。ho st 要素
は i d 属性または name 要素で特定します。
Red Hat Enterprise Virtualization 3.6 以降では、ストレージドメインの削除後にワイプのオプションをデ
フォルトで有効にすることができます。この設定は、P O ST 要求で <wi pe_after_d el ete> を指定しま
す。このオプションは、ドメインの作成後に編集することが可能ですが、その場合にはすでに存在していた
ディスクの「削除後にワイプ」プロパティーは変更されません。
例12.3 ストレージドメインの作成
POST /api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_domain>
<name>data1</name>
<type>data</type>
<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
<storage>
<type>nfs</type>
<address>172.31.0.6</address>
<path>/exports/RHEVX/images/0</path>
</storage>
</storage_domain>
作成後には、API ユーザーがそのストレージドメインをデータセンターにアタッチします。
12.4 .2. ストレージドメインの更新
name および wi pe after d el ete 要素だけが作成後に更新可能です。wi pe after d el ete 要素を変
更しても、すでに存在していたディスクの「削除後にワイプ」プロパティーは変更されません。
例12.4 ストレージドメインの更新
PUT /api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_domain>
<name>data2</name>
96
⁠第1 2 章 ストレージドメイン
...
<wipe_after_delete>true</wipe_after_delete>
...
</storage_domain>
12.4 .3. ストレージドメインの削除
ストレージドメインを削除するには D ELET E 要求を実行する必要があります。
例12.5 ストレージドメインの削除
DELETE /api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed HTTP/1.1
HTTP/1.1 204 No Content
12.5. ストレージタイプ
12.5.1. ストレージタイプ
sto rag e 要素には、type 要素 (列挙値) が含まれ、capabi l i ti es コレクションの下に記載されていま
す。
また、ストレージ要素には、各ストレージの type に固有の追加要素も含まれます。次の項では、これらの
ストレージ type 追加要素について考察します。
12.5.2. NFS ストレージ
次の表には、sto rag e の記述に含まれる nfs 固有の要素をまとめています。
表12.2 N FS 固有の要素
要素
タイプ
説明
ad d ress
文字列
NFS サーバーのホスト名または IP ア
ドレス
path
文字列
サーバー上でマウント可能な NFS
ディレクトリーのパス
プロパ
ティー
12.5.3. PosixFS ストレージ
以下の表には、sto rag e の記述に含まれる po si xfs 固有の要素をまとめています。
表12.3 Po sixFS 固有の要素
要素
タイプ
説明
プロパ
ティー
97
REST API ガイド
要素
タイプ
説明
ad d ress
文字列
PosixFS サーバーのホスト名または
IP アドレス
path
文字列
サーバー上にマウント可能な
PosixFS ディレクトリーのパス
vfs_type
文字列
PosixFS 共有の Linux 対応ファイル
システムのタイプ
mo unt_o pti o ns
文字列
PosixFS 共有のマウントオプション
プロパ
ティー
12.5.4 . iSCSI および FCP のストレージ
以下の表には、sto rag e の記述に含まれる i scsi および fcp の固有の要素を示します。
表12.4 iSC SI および FC P 固有の要素
要素
タイプ
説明
l o g i cal _uni t i d =
複合型
o verri d e_l uns
ブール値
論理ユニットの i d 。ストレージドメ
インは複数の iSCSI / FCP 論理ユ
ニットも受け入れます。
すべての論理単位設定を新しい設定に
置き換えるかどうかを定義します。上
書きする場合は true に設定します。
プロパ
ティー
l o g i cal _uni t にはサブ要素セットが含まれます。
表12.5 論理ユニットの要素
要素
タイプ
説明
ad d ress
文字列
ストレージデバイスを格納している
サーバーのアドレス
po rt
整数
サーバーのポート番号
targ et
文字列
ストレージデバイスのターゲット IQN
username
文字列
ターゲットにログインするための
CHAP ユーザー名
passwo rd
文字列
ターゲットにログインするための
CHAP パスワード
seri al
文字列
ターゲットのシリアル ID
vend o r_i d
文字列
ターゲットのベンダー名
98
プロパ
ティー
⁠第1 2 章 ストレージドメイン
要素
タイプ
説明
pro d uct_i d
文字列
ターゲットの製品コード
l un_mappi ng
整数
ターゲットの論理ユニット番号デバイ
スマッピング
プロパ
ティー
iSCSI を使用しており、l o g i cal _uni t の記述に該当する LUN を使用する iSCSI ターゲットの詳細も含
まれる場合には、そのターゲットはストレージの作成時に自動ログインを実行します。
12.5.5. LocalFS ストレージ
sto rag e の記述に含まれる l o cal fs 固有の要素
表12.6 Lo calf s 固有の要素
要素
タイプ
説明
path
文字列
ホスト上のローカルストレージドメイ
ンのパス
プロパ
ティー
l o cal fs ストレージドメインには、sto rag e_type が l o cal fs に設定されているデータセンターが必
要です。このデータセンターには、単一のホストクラスターのみが含まれ、そのホストクラスターには単一
のホストのみが含まれます。
12.6. エクスポートストレージドメイン
12.6.1. エクスポートストレージドメイン
type が expo rt に設定されているストレージドメインには、vms および templ ates のサブコレクショ
ンが含まれ、その特定のストレージドメインに格納されているインポート候補の仮想マシンおよびテンプ
レートが記載されています。
例12.6 エクスポートストレージドメインの仮想マシンサブコレクションの表示
GET /api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed/vms
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<vms>
<vm id="082c794b-771f-452f-83c9-b2b5a19c0399"
href="/api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed/
vms/082c794b-771f-452f-83c9-b2b5a19c0399">
<name>vm1</name>
...
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"
href="/api/storagedomains/fabe0451-701f-4235-8f7ee20e458819ed"/>
<actions>
99
REST API ガイド
<link rel="import" href="/api/storagedomains/
fabe0451-701f-4235-8f7e-e20e458819ed/vms/
082c794b-771f-452f-83c9-b2b5a19c0399/import"/>
</actions>
</vm>
</vms>
これらのコレクション内の仮想マシン/テンプレートに記載されている表現は、仮想マシン/テンプレートの
最上位コレクション内の対応する表現と同様ですが、sto rag e_d o mai n 参照と i mpo rt アクションも含
まれている点が異なります。
i mpo rt アクションは、expo rt ストレージドメインから仮想マシンまたはテンプレートをインポートしま
す。インポート先のクラスターおよびストレージドメインは cl uster と sto rag e_d o mai n の参照で指
定します。
仮想マシンまたはテンプレートに固有の名前を付ける場合は、オプションの name 要素を追加します。
例12.7 エクスポートストレージドメインから仮想マシンをインポートするアクション
POST /api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed/vms/
082c794b-771f-452f-83c9-b2b5a19c0399/import HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<storage_domain>
<name>images0</name>
</storage_domain>
<cluster>
<name>Default</name>
</cluster>
</action>
例12.8 エクスポートストレージドメインからテンプレートをインポートするアクション
POST /api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed/templates/
082c794b-771f-452f-83c9-b2b5a19c0399/import HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<storage_domain>
<name>images0</name>
</storage_domain>
<cluster>
<name>Default</name>
</cluster>
</action>
仮想マシンを新しいエンティティーとしてインポートする場合は、オプションの cl o ne ブール値要素を追
加します。
100
⁠第1 2 章 ストレージドメイン
例12.9 仮想マシンを新しいエンティティーとしてインポートする操作
POST /api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed/vms/
082c794b-771f-452f-83c9-b2b5a19c0399/import HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<storage_domain>
<name>images0</name>
</storage_domain>
<cluster>
<name>Default</name>
</cluster>
<clone>true</clone>
<vm>
<name>MyVM</name>
</vm>
...
</action>
各 d i sk i d 要素を使用してインポートするディスクを選択する場合は、オプションのd i sks 要素を追
加します。
例12.10 インポート操作を行うディスクの選択
POST /api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed/vms/
082c794b-771f-452f-83c9-b2b5a19c0399/import HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<cluster>
<name>Default</name>
</cluster>
<vm>
<name>MyVM</name>
</vm>
...
<disks>
<disk id="4825ffda-a997-4e96-ae27-5503f1851d1b"/>
</disks>
</action>
expo rt ストレージドメインからの仮想マシンおよびテンプレートの削除にはD ELET E 要求を使用しま
す。
例12.11 エクスポートストレージドメインからの仮想マシンの削除
DELETE /api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed/vms/
082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
101
REST API ガイド
Accept: application/xml
HTTP/1.1 204 No Content
12.7. Glance イメージストレージドメイン
12.7.1. Glance イメージストレージドメイン
タイプが Imag e に設定されたストレージドメインは、外部プロバイダーとして Red Hat Enterprise
Virtualization 環境に追加された OpenStack の Image Service のインスタンスを表します。これらの
Glance イメージストレージドメインには、Glance イメージストレージドメインへエクスポートされた仮
想マシンイメージまたはこのドメインからインポート可能な仮想マシンイメージを含む i mag es サブコレ
クションが含まれています。
例12.12 G lan ce イメージストレージドメインのイメージサブコレクションの一覧表示
GET /api/storagedomains/00000000-0000-0000-0000-000000000000/images
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<images>
<image href="/api/storagedomains/00000000-0000-0000-0000000000000000/images/
00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000000000000000">
<actions>
<link href="/api/storagedomains/00000000-0000-0000-0000000000000000/images/
00000000-0000-0000-0000-000000000000/import" rel="import"/>
</actions>
<name>RHEL_65_Disk_001</name>
<storage_domain href="/api/storagedomains/00000000-0000-0000-0000000000000000"
id="00000000-0000-0000-0000-000000000000"/>
</image>
<image href="/api/storagedomains/00000000-0000-0000-0000000000000000/images/
00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000000000000000">
<actions>
<link href="/api/storagedomains/00000000-0000-0000-0000000000000000/images/
00000000-0000-0000-0000-000000000000/import" rel="import"/>
</actions>
<name>RHEL_65_Disk_002</name>
<storage_domain href="/api/storagedomains/00000000-0000-0000-0000-
102
⁠第1 2 章 ストレージドメイン
000000000000"
id="00000000-0000-0000-0000-000000000000"/>
</image>
</images>
i mpo rt アクションは、Glance イメージストレージドメインから仮想マシンのイメージをインポートしま
す。インポート先のストレージドメインは、sto rag e_d o mai n 参照で、インポート先のクラスターは
cl uster で指定します。
仮想マシンまたはテンプレートに固有の名前を付ける場合は、オプションの name 要素を追加します。
例12.13 G lan ce イメージストレージドメインから仮想マシンをインポートするアクション
POST /api/storagedomains/00000000-0000-0000-000000000000/images/
00000000-0000-0000-000000000000/import HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<storage_domain>
<name>images0</name>
</storage_domain>
<cluster>
<name>images0</name>
</cluster>
</action>
また、i mpo rt_as_templ ate 参照を指定して、イメージをテンプレートとしてインポートすることも可
能です。
例12.14 G lan ce イメージストレージドメインから仮想マシンをテンプレートとしてインポートするア
クション
POST /api/storagedomains/00000000-0000-0000-000000000000/images/
00000000-0000-0000-000000000000/import HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<storage_domain>
<name>images0</name>
</storage_domain>
<cluster>
<name>images0</name>
</cluster>
</import_as_template>true</import_as_template>
</action>
12.8. サブコレクション
103
REST API ガイド
12.8.1. ファイルのサブコレクション
各ストレージドメインの下の fi l es サブコレクションは、クライアントで使用可能ファイルを表示する方
法を提供します。このサブコレクションは、管理者が Red Hat Enterprise Virtualization Manager でアッ
プロードした ISO イメージおよび仮想フロッピーディスク (VFD ) を格納する ISO ストレージドメインを特
に対象としています。
仮想マシンに CD -ROM デバイスを追加するには、ISO ストレージドメインの fi l es サブコレクションの
ISO イメージが必要です。
例12.15 ISO ストレージドメインの f iles サブコレクションの表示
GET /api/storagedomains/00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da/files
HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<files>
<file id="en_winxp_pro_with_sp2.iso"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e3c898fa8b6da/files/
en_winxp_pro_with_sp2.iso">
<name>en_winxp_pro_with_sp2.iso</name>
<type>iso</type>
<storage_domain id="00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e3c898fa8b6da"/>
</file>
<file id="boot.vfd"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e3c898fa8b6da/files/
boot.vfd">
<name>boot.vfd</name>
<type>vfd</type>
<storage_doman id="00f0d9ce-da15-4b9e-9e3e-3c898fa8b6da"
href="/api/storagedomains/00f0d9ce-da15-4b9e-9e3e3c898fa8b6da"/>
</file>
</files>
他のリソースと同様に、files にも不透明な i d と href の属性があります。name 要素にはファイル名が含
まれます。
12.9. アクション
12.9.1. 既存のストレージドメインのインポート
API は、下層のストレージの再フォーマットせずに、Red Hat Enterprise Virtualization Manager の 1 つ
のインスタンスから ISO ストレージドメインまたはエクスポートストレージドメインを削除して、そのド
メインを別のインスタンスにインポートする機能を提供しています。インポートの操作は、新規ストレージ
ドメインの追加と同じですが、name は指定しません。
104
⁠第1 2 章 ストレージドメイン
例12.16 既存のエクスポートストレージドメインのインポート
POST /api/storagedomains HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<storage_domain>
<type>export</type>
<storage>
<type>nfs</type>
<address>172.31.0.6</address>
<path>/exports/RHEVX/export-domain</path>
</storage>
<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</storage_domain>
HTTP/1.1 201 Created
Content-Type: application/xml
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"
href="/api/storagedomains/fabe0451-701f-4235-8f7e-e20e458819ed">
<name>export1</name>
...
</storage_domain>
12.9.2. ストレージドメインの削除
sto rag e_d o mai n 参照をストレージドメインの D ELET E 要求の本文に渡します。sto rag e_d o mai n
参照は以下のような形式です。
<storage_domain>
<host id="..."/>
</storage_domain>
または、
<storage_domain>
<host>
<name>...</name>
</host>
</storage_domain>
ストレージドメインのフォーマット
オプションの fo rmat 要素で、ストレージドメインを削除した後にフォーマットするかどうかを指定しま
す。
例12.17 ストレージドメイン削除後のフォーマット
105
REST API ガイド
<storage_domain>
<host id="..."/>
<format>true</format>
</storage_domain>
fo rmat 要素が渡されない場合には、ストレージドメインはフォーマットされない状態のままとなります。
ストレージドメインの論理削除
API はストレージドメインの論理削除する機能も提供します。これにより、ストレージドメインのインポー
ト用データが保持されます。d estro y 要素を使用してストレージドメインを論理的に削除し、データを保
持します。
例12.18 ストレージドメインの論理削除
<storage_domain>
<host id="..."/>
<destroy>true</destroy>
</storage_domain>
106
⁠第1 3章 ストレージ接続
第13章 ストレージ接続
13.1. ストレージ接続の要素
表13.1 ストレージ接続の基本要素
要素
タイプ
type
nfs、po si xfs、l o c ストレージドメインのタイプ
al 、i scsi のいずれか
1つ
文字列
ストレージドメインのホスト名または
IP アドレス
ad d ress
説明
プロパ
ティー
(NFS およ
び iSCSI の
場合のみ必
要)
ho st
文字列
ハイパーバイザーの i d または
name。ho st はオプションです。指
定した場合には、ホスト経由でスト
レージへの接続を試み、指定しなかっ
た場合には、データベース内のスト
レージ情報が保持されます。
表13.2 ファイルベースストレージのストレージ接続要素
要素
タイプ
説明
path
文字列
mo unt_o pti o ns
vfs_type
文字列
文字列
ストレージドメインのマウント済み
ファイルパス。path は、ストレージ
接続によってすでに使用されているパ
スには更新できません。
PosixFS 共有のマウントオプション
PosixFS 共有の Linux 対応ファイル
システムのタイプ
nfs_versi o n
nfs_ti meo
文字列
整数
nfs_retrans
整数
プロパ
ティー
使用する NFS のバージョン
NFS クライアントが要求の完了を待
機する時間 (デシ秒単位)
NFS クライアントが 1 つの要求を完
了するのに試みる再送信の回数
表13.3 ストレージ接続の iSC SI 要素
要素
タイプ
説明
po rt
整数
iSCSI ストレージドメインに使用する
TCP ポート
targ et
文字列
ストレージデバイスのターゲット IQN
プロパ
ティー
107
REST API ガイド
要素
タイプ
説明
username
文字列
passwo rd
文字列
ターゲットにログインするための
CHAP ユーザー名
ターゲットにログインするための
CHAP パスワード
プロパ
ティー
13.2. ストレージ接続リソースの XML 表現
例13.1 ストレージ接続リソースの XML 表現
<storage_connections>
<storage_connection href= "/api/storageconnections/608c5b96-99394331-96b5-197f28aa2e35"
id="608c5b96-9939-4331-96b5-197f28aa2e35">
<address>domain.example.com</address>
<type>nfs</type>
<path>/var/lib/exports/iso</path>
</storage_connection>
<storage_connection href= "/api/storageconnections/2ebb3f78-8c224666-8df4-e4bb7fec6b3a" id="2ebb3f78-8c22-4666-8df4-e4bb7fec6b3a">
<address>domain.example.com</address>
<type>posixfs</type>
<path>/export/storagedata/username/data</path>
<vfs_type>nfs</vfs_type>
</storage_connection>
</storage_connections>
13.3. メソッド
13.3.1. 新規ストレージ接続の作成
新規ストレージ接続を作成するには、P O ST 要求が必要です。
ストレージドメインを追加せずに新規ストレージ接続を作成することが可能です。ホストの i d または
name はオプションです。指定した場合には、そのホストを介してストレージへの接続を試みます。
例13.2 新規ストレージ接続の作成
POST /api/storageconnections HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_connection>
<type>nfs</type>
<address>domain.example.com</address>
<path>/export/storagedata/username/data</path>
108
⁠第1 3章 ストレージ接続
<host>
<name>Host_Name</name>
</host>
</storage_connection>
13.3.2. ストレージ接続の削除
ストレージ接続の削除には D ELET E 要求が必要です。ストレージ接続は、ストレージドメインと LUN ディ
スクのどちらもそのストレージ接続を参照していない場合にのみ削除することができます。
ホストの name と i d はオプションです。指定した場合には、接続はそのホストからアンマウントされま
す。
例13.3 ストレージ接続の削除
DELETE /api/storageconnections/Storage_Connection_ID HTTP/1.1
Accept: application/xml
Content-type: application/xml
<host>
<name>Host_Name</name>
</host>
13.3.3. ストレージ接続の更新
既存のストレージ接続を更新するには P UT 要求が必要です。接続を正しく更新するには、ストレージドメ
インはメンテナンスモードに入っているか、デタッチされている状態でなければなりません。
ホストの name または i d の指定はオプションです。指定した場合には、ホストが更新されたストレージ情
報への接続を試みます。
例13.4 ストレージ接続の更新
PUT /api/storageconnections/Storage_Connection_ID HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_connection>
<address>updated.example.domain.com</address>
<host>
<name>Host_name</name>
</host>
</storage_connection>
13.3.4 . iSCSI ストレージ接続の更新
既存の iSCSI ストレージ接続を更新するには P UT 要求が必要です。接続を正しく更新するには、iSCSI ス
トレージドメインはメンテナンスモードに入っているか、デタッチされている状態でなければなりません。
109
REST API ガイド
例13.5 ストレージ接続の更新
PUT /api/storageconnections/Storage_Connection_ID HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_connection>
<port>3456</port>
</storage_connection>
13.3.5. 既存のストレージ接続を使用する新規ストレージドメインの追加
既存のストレージ接続を使用する新規ストレージドメインを追加するには、P O ST 要求が必要です。これは
ファイルベースのストレージドメイン (NFS、P O SIX、および l o cal ) にのみ適用することができます。
例13.6 既存のストレージ接続を使用する新規ストレージドメインの追加
POST /api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_domain>
<name>New_Domain</name>
<type>data</type>
<storage id="Storage_Connection_ID"/>
<host>
<name>Host_Name</name>
</host>
</storage_domain>
13.3.6. iSCSI ストレージへの追加ストレージ接続のアタッチ
iSCSI ストレージドメインに追加のストレージ接続をアタッチするには P O ST 要求が必要です。
例13.7 iSC SI ストレージへの追加ストレージ接続のアタッチ
POST /api/storagedomains/iSCSI_Domain_ID/storageconnections HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storage_connection id="Storage_Connection_ID">
</storage_connection>
13.3.7. iSCSI ストレージからのストレージ接続のデタッチ
iSCSI ストレージドメインからストレージ接続をデタッチするには D ELET E 要求が必要です。
例13.8 iSC SI ストレージからのストレージ接続のデタッチ
110
⁠第1 3章 ストレージ接続
DELETE
/api/storagedomains/iSCSI_Domain_ID/storageconnections/Storage_Connecti
on_ID HTTP/1.1
Accept: application/xml
Content-type: application/xml
13.3.8. iSCSI ターゲットへの認証情報の定義
管理ポータルを使用して iSCSI ストレージドメインを追加すると、ユーザー名とパスワード 1 つずつしか
そのドメインに指定できませんが、設定によっては、クラスター内のホストごとに別のユーザー名とパス
ワードが必要なものもあります。sto rag eco nnecti o nextensi o ns 要素を使用すると、ホストごと
に、固有の認証情報を各 iSCSI ターゲットに適用することができます。
例13.9 iSC SI ターゲットへの認証情報の定義
POST /api/hosts/2ab5e1da-b726-4274-bbf70a42b16a0fc3/storageconnectionextensions HTTP/1.1
Accept: application/xml
Content-type: application/xml
<storageconnectionextension>
<target>iqn.2010.05.com.example:iscsi.targetX</target>
<username>jimmy</username>
<password>p@ 55w0Rd!</password>
</storageconnectionextension>
111
REST API ガイド
第14章 ホスト
14 .1. ホストの要素
ho sts コレクションは、Red Hat Enterprise Virtualization 環境内のホストに関する情報を提供します。
API ユーザーは、エントリーポイント URL から取得した rel = "ho sts" リンクでこの情報にアクセスしま
す。
G ET 要求に関する追加の情報は、Al l -C o ntent: true ヘッダーを使用して取得することができます。
以下の表には、ホストリソースの表現に含まれる特定の要素をまとめています。
表14 .1 ホストの要素
要素
タイプ
説明
l i nk
rel = "sto rag e"
l i nk rel = "ni cs"
リレーションシップ
l i nk
rel = "numano d es"
リレーションシップ
l i nk rel = "tag s"
リレーションシップ
ホストストレージの sto rag e サブコ
レクションへのリンク
ホストのネットワークインターフェー
スの ni cs サブコレクションへのリ
ンク
ホストの NUMA ノードの
numano d es サブコレクションへの
リンク
ホストのタグの tag s サブコレクショ
ンへのリンク
ホストパーミッションの
permi ssi o ns サブコレクションへ
のリンク
ホストの統計の stati sti cs サブコ
レクションへのリンク
ホストのフックの ho o ks サブコレク
ションへのリンク
ホストのフェンスエージェントの
fenceag ents サブコレクションへ
のリンク
ホストエラータの katel l o errata
サブコレクションへのリンク
リレーションシップ
l i nk
リレーションシップ
rel = "permi ssi o ns"
l i nk
rel = "stati sti cs"
l i nk rel = "ho o ks"
リレーションシップ
l i nk
rel = "fenceag ents"
リレーションシップ
l i nk
rel = "katel l o errat
a"
l i nk
rel = "d evi ces"
l i nk
rel = "netwo rkattac
hments"
l i nk
rel = "unmanag ed net
wo rks"
l i nk
rel = "sto rag eco nne
cti o nextensi o ns"
name
リレーションシップ
112
リレーションシップ
リレーションシップ
リレーションシップ
リレーションシップ
リレーションシップ
文字列
ホストデバイスの d evi ces サブコレ
クションへのリンク
ホストのネットワークインターフェー
スの netwo rkattachments サブコ
レクションへのリンク
ホストの管理対象外ネットワークの
unmanag ed netwo rks サブコレク
ションへのリンク
ホストストレージ接続の拡張機能の
sto rag eco nnecti o nextensi o n
s サブコレクションへのリンク
ホストの一意識別子
プロパ
ティー
⁠第1 4 章 ホスト
要素
タイプ
説明
ro o t_passwo rd
文字列
co mment
ad d ress
文字列
文字列
そのホストの root パスワード。規則
により、作成時にクライアント提供の
ホストの表現のみに記載されます。
ホストに関するコメント
ホストの IP アドレスまたはホスト名
certi fi cate
複合型
status
下記参照
external _status
複合型/列挙型
cl uster i d =
po rt
GUID
整数
type
rhel または rhev-h
ホストタイプ
sto rag e_manag er
pri o ri ty=
ブール値: true または
false
ホストがストレージマネージャーかど
うかを指定します。
versi o n majo r=
mi no r= bui l d =
revi si o n=
ful l _versi o n=
hard ware_i nfo rmat
ion
複合型
ホストの互換性レベル
複合型
po wer_manag ement
type=
複合型
ksm
transparent_hug ep
ag es
i scsi
ブール値: true または
false
ブール値: true または
false
複合型
manufacturer、versi o n、seri a
l _number、pro d uct_name、uui
d 、fami l y など、ホストのハード
ウェアに関する情報
enabl ed 、o pti o ns、kd ump_d et
ecti o n、auto mati c_pm_enabl e
d 、ag ents などを含む、ホストの電
源管理の設定オプション。ホストの電
源管理オプションに関する詳しい情報
は、「電源管理の要素」を参照してく
ださい。
KSM (Kernel SamePage Merging) が
有効化されている場合は true
Transparent Hugepages が有効化さ
れている場合は true
ホストの SCSI i ni ti ato r
ssh
複合型
プロパ
ティー
o rg ani zati o n および subject を
含むホストの証明書の詳細情報への参
照
ホストのステータス
外部システムおよびプラグインがレ
ポートするホストのヘルスステータ
ス。state 要素に
は、o k、i nfo 、warni ng 、erro r
または fai l ure の列挙値が含まれま
す。
そのホストを含むクラスタへの参照
そのホストで実行中の VD SM デーモ
ンのリッスンポート
po rt、fi ng erpri nt など、ホスト
との SSH 接続に関する詳細
113
REST API ガイド
要素
タイプ
説明
cpu
複合型
memo ry
整数
max_sched ul i ng _m
emo ry
summary
整数
o s type=
複合型
l i bvi rt_versi o n
majo r= mi no r=
bui l d = revi si o n=
ful l _versi o n=
複合型
ホスト CPU の統計。CPU の
name、to po l o g y
co res= 、to po l o g y
so ckets= 、to po l o g y
thread s= 、および speed のサブ要
素を含みます。to po l o g y co res=
はコア数の合計を集計
し、to po l o g y so ckets= は物理
CPU の合計を集計します。仮想マシ
ンが使用可能なコア数の合計は、ソ
ケット数に 1 ソケットあたりのコア
数を乗算した値と等しくなります。
ホストメモリーの合計容量 (バイト単
位)
スケジューリングに使用可能な最大メ
モリー量 (バイト)
ホスト上の仮想マシンの統計のサマ
リー。acti ve、mi g rati ng 、およ
び to tal の仮想マシン数のサブ要素
が含まれます。
versi o n ful l _versi o n= など、
ホストにインストールされたオペレー
ティングシステムの詳細
ホストの libvirt 互換性レベル
複合型
プロパ
ティー
status には次の列挙値のいずれかが含まれます:
d o wn、erro r、i ni ti al i zi ng 、i nstal l i ng 、i nstal l _fai l ed 、mai ntenance、no n_o per
ati o nal 、no n_respo nsi ve、pend i ng _appro val 、prepari ng _fo r_mai ntenance、co nnec
ti ng 、rebo o t、unassi g ned 、up。 これらのステータスは、capabi l i ti es の下の ho st_states
に記載されています。
14 .2. ホストの XML 表現
例14 .1 ホストの XML 表現
<host href="/api/hosts/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000">
<actions>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/upgrade" rel="upgrade"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/setupnetworks" rel="setupnetworks"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/fence" rel="fence"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/refresh" rel="refresh"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/install" rel="install"/>
114
⁠第1 4 章 ホスト
<link href="/api/hosts/00000000-0000-0000-0000000000000000/activate" rel="activate"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/deactivate" rel="deactivate"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/approve" rel="approve"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/forceselectspm" rel="forceselectspm"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/enrollcertificate" rel="enrollcertificate"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/iscsilogin" rel="iscsilogin"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/unregisteredstoragedomainsdiscover"
rel="unregisteredstoragedomainsdiscover"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/iscsidiscover" rel="iscsidiscover"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/commitnetconfig" rel="commitnetconfig"/>
</actions>
<name>host1</name>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/storage" rel="storage"/>
<link href="/api/hosts/00000000-0000-0000-0000-000000000000/nics"
rel="nics"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/numanodes" rel="numanodes"/>
<link href="/api/hosts/00000000-0000-0000-0000-000000000000/tags"
rel="tags"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/permissions" rel="permissions"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/statistics" rel="statistics"/>
<link href="/api/hosts/00000000-0000-0000-0000-000000000000/hooks"
rel="hooks"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/fenceagents" rel="fenceagents"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/katelloerrata" rel="katelloerrata"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/devices" rel="devices"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/networkattachments" rel="networkattachments"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/unmanagednetworks" rel="unmanagednetworks"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/storageconnectionextensions"
rel="storageconnectionextensions"/>
<address>host1.example.com</address>
<certificate>
<organization>exampleorg</organization>
<subject>O=exampleorg,CN=XX.XX.XX.XX</subject>
</certificate>
<status>
<state>up</state>
</status>
115
REST API ガイド
<external_status>
<state>ok</state>
</external_status>
<cluster href="/api/clusters/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000"/>
<port>54321</port>
<type>rhel</type>
<storage_manager priority="2">false</storage_manager>
<spm>
<priority>2</priority>
<status>
<state>none</state>
</status>
</spm>
<version major="4" minor="17" build="20" revision="0"
full_version="vdsm-4.17.20-0.el7ev"/>
<power_management>
<enabled>false</enabled>
<pm_proxies/>
<automatic_pm_enabled>true</automatic_pm_enabled>
<kdump_detection>true</kdump_detection>
</power_management>
<ksm>
<enabled>true</enabled>
</ksm>
<transparent_hugepages>
<enabled>true</enabled>
</transparent_hugepages>
<iscsi>
<initiator>iqn.2001-04.com.example:diskarrays-sna8675309</initiator>
</iscsi>
<ssh>
<port>22</port>
<fingerprint>00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00</fingerpr
int>
</ssh>
<cpu>
<topology cores="2" sockets="1"/>
<name>Intel(R) Xeon(R) CPU E5430 @ 2.66GHz</name>
<speed>2656</speed>
</cpu>
<memory>12430868480</memory>
<max_scheduling_memory>12026118144</max_scheduling_memory>
<summary>
<active>2</active>
<migrating>0</migrating>
<total>3</total>
</summary>
<protocol>stomp</protocol>
<os type="RHEL">
<version full_version="7.2-9.el7_2.1"/>
</os>
<libvirt_version major="1" minor="2" build="17" revision="0"
full_version="libvirt-1.2.17-13.el7_2.2"/>
116
⁠第1 4 章 ホスト
<kdump_status>disabled</kdump_status>
<selinux>
<mode>enforcing</mode>
</selinux>
<auto_numa_status>disable</auto_numa_status>
<numa_supported>false</numa_supported>
<live_snapshot_support>true</live_snapshot_support>
<update_available>false</update_available>
<device_passthrough>
<enabled>true</enabled>
</device_passthrough>
</host>
14 .3. ホストの JSON 表現
例14 .2 ホストの JSO N 表現
{
"host" : [ {
"address" : "198.51.100.0",
"certificate" : {
"organization" : "example.com",
"subject" : "O=example.com,CN=192.0.2.0"
},
"status" : {
"state" : "up"
},
"cluster" : {
"href" : "/api/clusters/00000001-0001-0001-0001-0000000002fb",
"id" : "00000001-0001-0001-0001-0000000002fb"
},
"port" : "54321",
"type" : "rhel",
"storage_manager" : {
"value" : "true",
"priority" : "5"
},
"spm" : {
"priority" : "5"
},
"version" : {
"major" : "4",
"minor" : "16",
"build" : "8",
"revision" : "1",
"full_version" : "vdsm-4.16.8.1-6.el6ev"
},
"hardware_information" : {
"manufacturer" : "System Manufacturer To Be Filled By O.E.M.",
"version" : "System Version To Be Filled By O.E.M.",
"serial_number" : "Serial Number To Be Filled By O.E.M.",
"product_name" : "Product Name To Be Filled By O.E.M.",
"uuid" : "9fa0a1a2-a3a4-a5a6-a7a8-a9aaabacadae",
117
REST API ガイド
"family" : "Family To Be Filled By O.E.M.",
"supported_rng_sources" : {
"source" : [ "RANDOM" ]
}
},
"power_management" : {
"enabled" : "false",
"options" : {
"option" : [ {
"name" : "secure",
"value" : "false"
} ]
},
"automatic_pm_enabled" : "true",
"kdump_detection" : "true",
"type" : "apc"
},
"ksm" : {
"enabled" : "false"
},
"transparent_hugepages" : {
"enabled" : "true"
},
"iscsi" : {
"initiator" : "iqn.1994-05.com.example:795610ff2632"
},
"ssh" : {
"port" : "22",
"fingerprint" : "77:27:38:25:8f:60:8d:93:9c:2c:b0:cb:5e:19:f4:53"
},
"cpu" : {
"topology" : {
"sockets" : "1",
"cores" : "4",
"threads" : "1"
},
"name" : "Intel(R) Core(TM)2 Quad CPU
Q9550 @ 2.83GHz",
"speed" : 2833
},
"memory" : 2989490176,
"max_scheduling_memory" : 2584739840,
"summary" : {
"active" : "0",
"migrating" : "0",
"total" : "0"
},
"protocol" : "stomp",
"os" : {
"version" : {
"full_version" : "6Server - 6.6.0.2.el6"
},
"type" : "RHEL"
},
"libvirt_version" : {
"major" : "0",
"minor" : "10",
118
⁠第1 4 章 ホスト
"build" : "2",
"revision" : "0",
"full_version" : "libvirt-0.10.2-46.el6_6.2"
},
"kdump_status" : "disabled",
"selinux" : {
"mode" : "enforcing"
},
"auto_numa_status" : "unknown",
"numa_supported" : "false",
"live_snapshot_support" : "true",
"actions" : {
"link" : [ {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/fence",
"rel" : "fence"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/approve",
"rel" : "approve"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/forceselectspm",
"rel" : "forceselectspm"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/iscsilogin",
"rel" : "iscsilogin"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/iscsidiscover",
"rel" : "iscsidiscover"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/commitnetconfig",
"rel" : "commitnetconfig"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/deactivate",
"rel" : "deactivate"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/install",
"rel" : "install"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/activate",
"rel" : "activate"
} ]
},
"name" : "Host-07",
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350-d86f005c93fe",
"id" : "ea7aa772-d2af-4a5c-9350-d86f005c93fe",
"link" : [ {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/storage",
119
REST API ガイド
"rel" : "storage"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350-d86f005c93fe/nics",
"rel" : "nics"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/numanodes",
"rel" : "numanodes"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350-d86f005c93fe/tags",
"rel" : "tags"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/permissions",
"rel" : "permissions"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350d86f005c93fe/statistics",
"rel" : "statistics"
}, {
"href" : "/api/hosts/ea7aa772-d2af-4a5c-9350-d86f005c93fe/hooks",
"rel" : "hooks"
} ]
} ]
}
14 .4 . 電源管理の要素
po wer_manag ement 要素は、ホストのフェンシングに必要な電源管理設定を指定する機能をユーザーに
提供します。po wer_manag ement を設定する際には、特定のサブ要素が必要です。
表14 .2 電源管理のオプション
要素
タイプ
説明
type=
フェンスデバイスコー
ド
enabl ed
ブール値: true または
false
有効なフェンスデバイスコードの一覧
は capabi l i ti es コレクション内
にあります。
電源管理設定が有効化または無効化さ
れているかを示します。
ad d ress
文字列
ホストの IP アドレスまたはホスト名
username
passwo rd
文字列
文字列
o pti o ns
複合型
電源管理の有効なユーザー名
電源管理用の有効かつ堅固なパスワー
ド
選択した type= のフェンシングオプ
ション。オプションの name= "" と
val ue= "" の文字列で指定します。
120
プロパ
ティー
⁠第1 4 章 ホスト
要素
タイプ
説明
ag ents
複合型
auto mati c_pm_enab
l ed
ブール値: true または
false
kd ump_d etecti o n
ブール値: true または
false
複数のフェンスが使用されている場合
に、フェンスエージェントのオプ
ションを指定します。o rd er サブ要
素を使用して、フェンスエージェント
の優先順位付けをします。エージェン
トは、フェンスアクションが成功する
まで、この順番に従い順次実行されま
す。同じ o rd er が指定されるフェン
スエージェントが複数ある場合には、
同時に実行されます。他のサブ要素に
は、type、i p、user、passwo rd
、o pti o ns などがあります。
節電のためのホストの自動電源制御を
切り替えます。この値を true に設定
すると、クラスターの負荷が低下した
場合にホストは自動的にオフになり、
必要に応じて再度電源が投入されま
す。この値は、ユーザーが無効にしな
い限り、ホストの作成時に true に設
定されます。
ホストがシャットダウンする前に
kdump が実行中かどうかを確認する
設定を切り替えます。この値を true
に指定すると、kdump プロセスの間
はホストのシャットダウンは行われま
せん。この値は、ユーザーによって無
効にされない限り、ホストの電源管理
が有効化されている場合は true に指
定されます。
プロパ
ティー
o pti o ns 要素には o pti o n サブ要素の一覧が必要です。各 o pti o n には name と type の属性が必要で
す。capabi l i ti es コレクションに定義されているように、特定のフェンシングタイプにしか使用でき
ないオプションがあります。
ホストリソースに対して P O ST 要求を実行する場合には、新規のホストにオプションの
po wer_manag ement 設定を記載します。po wer_manag ement 設定は P UT 要求を使用して更新するこ
とができます。
例14 .3 ホストの電源管理設定の XML 表現
<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"
href="/api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3">
<name>host1</name>
...
<power_management type="ilo">
<enabled>true</enabled>
<address>192.168.1.107</address>
<username>admin</username>
<password>p@ 55w0Rd!</password>
<options>
<option name="secure" value="true"/>
<option name="port" value="54345"/>
121
REST API ガイド
<option name="slot" value="3"/>
</options>
<agents>
<agent id="07f0b9ce-923a-4a96-a532-3c898fa8b6da">
<type>apc</type>
<order>1</order>
<ip>192.168.1.111</ip>
<user>example</user>
<password>p@ 55w0rd!</password>
<port>9</port>
<options>
<option name="power_wait" value="5"/>
<option name="secure" value="false"/>
</options>
</agent>
<agent id="50c71ba2-8495-11e0-b931-e20e458819ed">
<type>rsa</type>
<order>2</order>
<ip>192.168.1.112</ip>
<user>example</user>
<password>p@ 55w0rd!</password>
<port>9</port>
<options>
<option name="power_wait" value="5"/>
<option name="secure" value="false"/>
</options>
</agent>
</agents>
<automatic_pm_enabled>true</automatic_pm_enabled>
<kdump_detection>true</kdump_detection>
</power_management>
...
</host>
14 .5. メモリー管理の要素
API は、ホストのメモリー管理に 2 つの設定値を提供しています。
K ern el SamePag e Merg in g ( K SM) は、メモリーページへの参照を、複数の同じページからの単一の
ページ参照に削減します。これにより、メモリーの密度が最適化されます。KSM は ksm 要素を使用しま
す。
例14 .4 K SM メモリー管理の設定
PUT /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3 HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"
href="/api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3">
<ksm>true</ksm>
</host>
122
⁠第1 4 章 ホスト
T ran sp aren t H u g ep ag e su p p o rt は、メモリーページを標準の 4KB の上限を上回るサイズに拡張しま
す。これによりメモリーの消費が低減され、ホストのパフォーマンスが向上します。Transparent
Hugepage サポートには transparent_hug epag es 要素を使用します。
例14 .5 T ran sp aren t H u g ep ag e メモリー管理の設定
PUT /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3 HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"
href="/api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3">
<transparent_hugepages>true</transparent_hugepages>
</host>
Transparent Hugepage がサポートされているかどうかについては、capabi l i ti es コレクションで確
認することができます。
14 .6. メソッド
14 .6.1. ホストの作成
新規ホストの作成には name、ad d ress、および ro o t_passwo rd 要素が必要です。
例14 .6 ホストの作成
POST /api/hosts HTTP/1.1
Accept: application/xml
Content-type: application/xml
<host>
<name>host2</name>
<address>host2.example.com</address>
<root_password>p@ 55w0Rd!</root_password>
</host>
新規ホストの作成は Red Hat Enterprise Linux ホストを追加する場合のみに適用されます。Red Had
Enterprise Virtualization Manager は Hypervisor ホストを自動検出し、使用の承認を要求します。
ro o t_passwo rd 要素が記載されるのは、クライアント提供の最初の表現のみです。それ以降の要求で返
される表現には表示されません。
14 .6.2. ホストの更新
name、d escri pti o n、cl uster、po wer_manag ement、transparent_hug epag es、ksm の各要
素は、作成後に更新が可能です。
例14 .7 ホストの更新
123
REST API ガイド
POST /api/hosts/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<host>
<name>host3</name>
</host>
14 .6.3. ホストの削除
ホストを削除するには D ELET E 要求を実行する必要があります。
例14 .8 ホストの削除
DELETE /api/hosts/00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
14 .7. サブコレクション
14 .7.1. ホストのネットワークアタッチメントのサブコレクション
netwo rk_attachments サブコレクションは、ホストのネットワーク設定を表現します。各
netwo rk_attachment 要素は、ホストにアタッチされたネットワークを表現しており、この要素には以
下の要素が含まれます。
表14 .3 ホストのネットワークアタッチメントの要素
要素
タイプ
説明
netwo rk i d =
GUID
ホストがアタッチされたネットワーク
への参照
ho st_ni c i d =
GUID
i p_ad d ress_assi g nment
s
複合型
pro perti es
複合型
ネットワークがアタッチされるホスト
ネットワークインターフェースへの参
照
ネットワークの IP 設定。
各i p_ad d ress_assi g nment に
は、assi g nment_metho d と i p
ad d ress= netmask= g ateway=
サブ要素が含まれています。
ネットワークのカスタムプロパティー
キーを定義します。各 pro perty に
は name および val ue のサブ要素が
含まれます。「ネットワークアタッチ
メントのカスタムプロパティー」を参
照してください。
124
プロパ
ティー
⁠第1 4 章 ホスト
要素
タイプ
説明
repo rted _co nfi g urati o
ns
複合型
ho st i d =
GUID
読み取り専用のネットワークアタッチ
メントの設定プロパティー一覧。ネッ
トワークアタッチメントがデータセン
ターの論理ネットワーク定義と同期さ
れてない場合には、i n_sync ブール
値は fal se です。各
repo rted _co nfi g urati o n には
name、expected _val ue、actua
l _val ue、i n_sync サブ要素が含
まれます。
ホストへの参照
プロパ
ティー
例14 .9 ホスト上のネットワークアタッチメントの XML 表現
<network_attachment href="/api/hosts/00000000-0000-0000-0000000000000000/networkattachments/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000">
<network href="/api/networks/00000000-0000-0000-0000-000000000009"
id="00000000-0000-0000-0000-000000000009"/>
<host_nic href="/api/hosts/00000000-0000-0000-0000000000000000/nics/00000000-0000-0000-0000-000000000000" id="000000000000-0000-0000-000000000000"/>
<ip_address_assignments>
<ip_address_assignment>
<ip address="XX.XX.XX.XX" netmask="255.255.255.0"
gateway="XX.XX.XX.XX"/>
<assignment_method>dhcp</assignment_method>
</ip_address_assignment>
</ip_address_assignments>
<reported_configurations>
<in_sync>true</in_sync>
<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_configuration>
<name>vlan</name>
<in_sync>true</in_sync>
</reported_configuration>
<reported_configuration>
<name>boot_protocol</name>
<expected_value>DHCP</expected_value>
<actual_value>DHCP</actual_value>
125
REST API ガイド
<in_sync>true</in_sync>
</reported_configuration>
</reported_configurations>
<host href="/api/hosts/f59a29cd-587d-48a3-b72a-db537eb21957"
id="f59a29cd-587d-48a3-b72a-db537eb21957"/>
</network_attachment>
ホストをネットワークにアタッチする際には、i d または name を指定した netwo rk と ho st_ni c 要素
が必要です。ho st_ni c ID は、未使用のネットワークインターフェースカードまたはボンぢングのいずれ
かを参照することができます。
例14 .10 ホストへのネットワークのアタッチ
POST /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000/networkattachments HTTP/1.1
Accept: application/xml
Content-type: application/xml
<network_attachment>
<network id="00000000-0000-0000-0000-000000000000"/>
<host_nic id="00000000-0000-0000-0000-000000000000"/>
</network_attachment>
ho st_ni c、i p_ad d ress_assi g nments、pro perti es 要素は、作成後に更新可能です。ho st_ni c
ID を変更すると、ネットワークが別のネットワークインターフェースカードに移動されます。
例14 .11 ホストネットワークのアタッチメントの変更
PUT /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000/networkattachments/00000000-0000-00000000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<network_attachment>
<host_nic id="00000000-0000-0000-0000-000000000000"/>
<ip_address_assignments>
<ip_address_assignment>
<ip address="XX.XX.XX.XX" netmask="255.255.255.0"
gateway="XX.XX.XX.XX"/>
<assignment_method>static</assignment_method>
</ip_address_assignment>
</ip_address_assignments>
<properties>
<property>
<name>bridge_opts</name>
<value>
forward_delay=1500 group_fwd_mask=0x0 multicast_snooping=1
</value>
</property>
</properties>
</network_attachment>
126
⁠第1 4 章 ホスト
ネットワークアタッチメントに対する D ELET E 要求を使用して、ホストからネットワークをデタッチしま
す。
例14 .12 ホストからのネットワークのデタッチ
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000/networkattachments/00000000-0000-00000000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
HTTP/1.1 204 No Content
重要
ネットワークアタッチメントの設定への変更は明示的にコミットする必要があります。「ネット
ワーク設定をコミットするアクション」を参照してください。
14 .7.2. ホストのネットワークインターフェースのサブコレクション
1 4 .7 .2 .1 . ホストのネットワークインターフェースのサブコレクション
ni cs サブコレクションは、ホストの物理ネットワークインターフェースを表します。G ET 要求に関する
追加の情報は、Al l -C o ntent: true ヘッダーを使用して取得することができます。表現内の各
ho st_ni c 要素はネットワークインターフェースとして機能し、次の要素を含みます。
表14 .4 ホストのネットワークインターフェースの要素
要素
タイプ
説明
name
文字列
ホストのネットワークインターフェー
ス名 (例: eth0 )
l i nk rel = "stati sti cs"
l i nk rel = "l abel s"
l i nk
rel = "netwo rkattachment
s"
l i nk rel = "master"
プロパ
ティー
⁠ [a]
リレーションシッ ホストのネットワークインターフェー
プ
ス統計の stati sti cs サブコレク
ションへのリンク
リレーションシッ ホストのネットワークインターフェー
プ
スラベルの l abel s サブコレクショ
ンへのリンク
リレーションシッ ホストのネットワークインターフェー
プ
ス設定の netwo rkattachments サ
ブコレクションへのリンク
リレーションシッ スレーブインターフェースである場合
プ
は、マスターのボンディングインター
フェースへの参照
127
REST API ガイド
要素
タイプ
説明
ho st i d =
GUID
ホストへの参照
netwo rk i d =
GUID
mac ad d ress=
文字列
インターフェースがアタッチされた
ネットワークがある場合は、そのネッ
トワークへの参照
インターフェースの MAC アドレス
i p ad d ress= netmask=
g ateway= mtu=
mtu
bo o t_pro to co l
複合型
インターフェースの IP レベルの設定
複合型
列挙型
status
列挙型
vl an i d
整数
インターフェースの最大伝送単位
ホスト起動時の IP アドレス割り当て
のプロトコル。列挙値の一覧は
capabi l i ti es に記載されていま
す。
ネットワークインターフェースのリン
クステータス。これらのステータスは
capabi l i ti es の下の
ho st_ni c_states に記載されてい
ます。
このインターフェースが表している
VLAN
bo nd i ng
複合型
bri d g ed
ブール値
プロパ
ティー
ボンディングインターフェースの
o pti o ns と sl ave の各 NIC の一覧
⁠ [b ]
⁠ [c ]
ネットワークのブリッジングステータ
スを定義します。ブリッジされたネッ
トワークの場合は true に、ブリッジ
されていないネットワークの場合は
fal se に設定します。
[a] ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追
加することはできません。
[b ] ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追
加することはできません。
[c ] ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追
加することはできません。
例14 .13 ホスト上のネットワークインターフェースの XML 表現
<host_nic id="00000000-0000-0000-0000-000000000000"
href="/api/hosts/00000000-0000-0000-0000-000000000000/nics/
00000000-0000-0000-0000-000000000000">
<actions>
<link rel="attach"
href="/api/hosts/00000000-0000-0000-0000-000000000000/nics/
00000000-0000-0000-0000-000000000000/attach"/>
<link rel="detach"
href="/api/hosts/00000000-0000-0000-0000-000000000000/nics/
00000000-0000-0000-0000-000000000000/detach"/>
</actions>
128
⁠第1 4 章 ホスト
<name>bond0</name>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/nics/00000000-0000-0000-0000-000000000000/statistics"
rel="statistics"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/nics/00000000-0000-0000-0000-000000000000/labels"
rel="labels"/>
<link href="/api/hosts/00000000-0000-0000-0000000000000000/nics/00000000-0000-0000-0000000000000000/networkattachments" rel="networkattachments"/>
<host href="/api/hosts/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000"/>
<network href="/api/networks/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000"/>
<mac address="00:00:00:00:00:00"/>
<ip address="XX.XX.XX.XX" netmask="255.255.255.0"
gateway="XX.XX.XX.XX"/>
<boot_protocol>dhcp</boot_protocol>
<status>
<state>up</state>
</status>
<bonding>
<options>
<option name="mode" value="4" type="Dynamic link
aggregation (802.3ad)"/>
<option name="miimon" value="100"/>
</options>
<slaves>
<host_nic id="00000000-0000-0000-0000-000000000000"/>
<host_nic id="00000000-0000-0000-0000-000000000000"/>
</slaves>
</bonding>
<mtu>1500</mtu>
<bridged>true</bridged>
<custom_configuration>false</custom_configuration>
</host_nic>
REST API では、ボンディングインターフェースのみが作成可能です。「ボンディングインターフェー
ス」を参照してください。その他のネットワークインターフェースにはすべて、更新可能な
netwo rk、i p、bo o t_pro to co l の要素が含まれます。
P UT 要求を使用してネットワークインターフェースを変更します。
PUT /api/hosts/00000000-0000-0000-0000-000000000000/nics/
00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<host_nic>
<ip address="XX.XX.XX.XX" netmask="255.255.255.0"
gateway="XX.XX.XX.XX"/>
<boot_protocol>static</boot_protocol>
</host_nic>
D ELET E 要求でネットワークインターフェースを削除します。
129
REST API ガイド
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/
00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
1 4 .7 .2 .2 . ボンディングインターフェース
ボンディングインターフェースは bo nd i ng 要素を含む ho st_ni c のリソースとして表します。
表14 .5 ボンディングインターフェースのプロパティー
要素
タイプ
説明
o pti o ns
複合型
ボンディングインターフェースの
o pti o n 要素の一覧。各 o pti o n に
はプロパティーの name と val ue の
属性が含まれます。
sl aves
複合型
プロパ
ティー
ボンディングインターフェースのス
レーブ ho st_ni c i d = 要素の一覧
⁠ [a]
⁠ [b ]
[a] ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追
加することはできません。
[b ] ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追
加することはできません。
API ユーザーは、ho st_ni c (P O ST ) の作成時、または ho st_ni c (P UT ) の更新時に新しいボンディング
を作成します。i d または name 要素のいずれかを使用して、スレーブ ho st_ni c 要素を特定します。新
しいネットワークインターフェースを追加するには、name と netwo rk 要素が必要です。i d 属性または
name 要素で netwo rk 要素を特定します。
例14 .14 ボンディングインターフェースの作成
POST /api/hosts/00000000-0000-0000-0000-000000000000/nics HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<host_nic>
<name>bond4</name>
<network id="00000000-0000-0000-0000-000000000000"/>
<bonding>
<slaves>
<host_nic id="00000000-0000-0000-0000-000000000000"/>
<host_nic id="00000000-0000-0000-0000-000000000000"/>
</slaves>
</bonding>
</host_nic>
130
⁠第1 4 章 ホスト
重要
ボンディングインターフェースの有効な名前は、bo nd 0 、bo nd 1、bo nd 2, bo nd 3、bo nd 4 のみ
です。
例14 .15 ボンディングインターフェースの削除
D ELET E 要求でボンディングインターフェースを削除します。
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
重要
ボンディングインターフェースの設定に対する変更は、明示的にコミットする必要がありま
す。「ネットワーク設定をコミットするアクション」を参照してください。
1 4 .7 .2 .3. ネットワークインターフェースのネットワークアタッチメント
14 .7.2.3.1. ネットワークインターフェースのネットワークアタッチメント
ホストの各ネットワークインターフェースは、ネットワークインターフェースカードのネットワークア
タッチメントを表現する netwo rk_attachments サブコレクションを公開します。各
netwo rk_attachment は、ネットワークインターフェースにアタッチされるネットワークを表現してお
り、このサブコレクションには以下の要素が含まれます。
表14 .6 ホストネットワークインターフェースのネットワークアタッチメントの要素
要素
タイプ
説明
netwo rk i d =
GUID
インターフェースがアタッチされた
ネットワークへの参照
ho st_ni c i d =
GUID
ホストのネットワークインターフェー
スへの参照
i p_ad d ress_assi g nment
s
複合型
pro perti es
複合型
ネットワークの IP 設定。
各i p_ad d ress_assi g nment に
は、assi g nment_metho d と i p
ad d ress= netmask= g ateway=
サブ要素が含まれています。
ネットワークのカスタムプロパティー
キーを定義します。各 pro perty に
は name および val ue のサブ要素が
含まれます。
プロパ
ティー
131
REST API ガイド
要素
タイプ
説明
repo rted _co nfi g urati o
ns
複合型
読み取り専用のネットワークアタッチ
メントの設定プロパティー一覧。ネッ
トワークアタッチメントにコミットさ
れていないネットワーク設定が含まれ
ている場合には、i n_sync ブール値
は fal se です。各
repo rted _co nfi g urati o n には
name、expected _val ue、actua
l _val ue、i n_sync サブ要素が含
まれます。
プロパ
ティー
例14 .16 ネットワークインターフェースカードのネットワークアタッチメントのXML 表現
<network_attachment href="/api/hosts/00000000-0000-0000-0000000000000000/nics/00000000-0000-0000-0000000000000000/networkattachments/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000">
<network href="/api/networks/00000000-0000-0000-0000-000000000009"
id="00000000-0000-0000-0000-000000000009"/>
<host_nic href="/api/hosts/00000000-0000-0000-0000000000000000/nics/00000000-0000-0000-0000-000000000000" id="000000000000-0000-0000-000000000000"/>
<ip_address_assignments>
<ip_address_assignment>
<ip address="XX.XX.XX.XX" netmask="255.255.255.0"
gateway="XX.XX.XX.XX"/>
<assignment_method>static</assignment_method>
</ip_address_assignment>
</ip_address_assignments>
<reported_configurations>
<in_sync>true</in_sync>
<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_configuration>
<name>vlan</name>
<in_sync>true</in_sync>
</reported_configuration>
<reported_configuration>
<name>boot_protocol</name>
<expected_value>DHCP</expected_value>
<actual_value>DHCP</actual_value>
132
⁠第1 4 章 ホスト
<in_sync>true</in_sync>
</reported_configuration>
</reported_configurations>
</network_attachment>
ネットワークインターフェースカードにネットワークをアタッチする場合は、i d または name のいずれか
と、netwo rk 要素が必要です。
例14 .17 ホストのネットワークインターフェースカードに対するネットワークのアタッチ
POST /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000/networkattachments HTTP/1.1
Accept: application/xml
Content-type: application/xml
<networkattachment>
<network id="00000000-0000-0000-0000-000000000000"/>
</networkattachment>
i p_ad d ress_assi g nments と pro perti es 要素は、作成後に更新可能です。
例14 .18 ネットワークアタッチメントの変更
PUT /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000/networkattachments/00000000-0000-00000000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<networkattachment>
<ip_address_assignments>
<ip_address_assignment>
<ip address="XX.XX.XX.XX" netmask="255.255.255.0"
gateway="XX.XX.XX.XX"/>
<assignment_method>static</assignment_method>
</ip_address_assignment>
</ip_address_assignments>
</networkattachment>
ネットワークアタッチメントに対する D ELET E 要求を使用して、ネットワークインターフェースからネッ
トワークをデタッチします。
例14 .19 ホストネットワークインターフェースカードからのネットワークのデタッチ
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000/networkattachments/00000000-0000-00000000-000000000000 HTTP/1.1
Accept: application/xml
133
REST API ガイド
Content-type: application/xml
HTTP/1.1 204 No Content
重要
ネットワークアタッチメントの設定への変更は明示的にコミットする必要があります。「ネット
ワーク設定をコミットするアクション」を参照してください。
14 .7.2.3.2. ネットワークアタッチメントのカスタムプロパティー
ホストのネットワークアタッチメントにカスタムプロパティーを適用することができます。各プロパ
ティーには name と val ue のサブ要素が含まれます。カスタムプロパティーを変更するには、ネットワー
クアタッチメントに対して P UT 要求を実行するか、setupnetwo rks アクションを使用して P O ST 要求
を実行してください。
表14 .7 ホストネットワークインターフェースのカスタムブリッジオプションの要素
要素
タイプ
説明
name
文字列
val ue
文字列
プロパティーの一意識別子。ブリッジオプションに
は、bri d g e_o pts というセット名があります。
有効なキーと値を「[key]=[value]」の構文で示すブリッジ
オプション。エントリーが複数ある場合には、空白文字
で区切ります。有効なキーは以下のようになります。値は
例として示しています。
fo rward _d el ay=1500
g c_ti mer=3765
g ro up_ad d r=1:80:c2:0:0:0
g ro up_fwd _mask=0x0
hash_el asti ci ty=4
hash_max=512
hel l o _ti me=200
hel l o _ti mer=70
max_ag e=2000
mul ti cast_l ast_member_co unt=2
mul ti cast_l ast_member_i nterval =100
mul ti cast_membershi p_i nterval =26000
mul ti cast_q ueri er=0
mul ti cast_q ueri er_i nterval =25500
mul ti cast_q uery_i nterval =13000
mul ti cast_q uery_respo nse_i nterval =1000
mul ti cast_q uery_use_i fad d r=0
mul ti cast_ro uter=1
mul ti cast_sno o pi ng =1
mul ti cast_startup_q uery_co unt=2
mul ti cast_startup_q uery_i nterval =3125
例14 .20 ネットワークアタッチメントのプロパティーサブコレクションの XML 表現
<network_attachment>
...
134
⁠第1 4 章 ホスト
<properties>
<property>
<name>bridge_opts</name>
<value>
forward_delay=1500 group_fwd_mask=0x0 multicast_snooping=1
</value>
</property>
</properties>
...
</network_attachment>
1 4 .7 .2 .4 . ネットワークインターフェースのラベル
ホストのネットワークインターフェースカードにラベルをつけて、同じラベルが付けられた論理ネットワー
クとネットワークインターフェースカードを自動的に関連付けることができます。
例14 .21 ネットワークインターフェースカードへのラベルのアタッチ
POST /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000/labels HTTP/1.1
Accept: application/xml
Content-type: application/xml
<label id="Label_001" />
物理ホストのネットワークインターフェースカードからラベルを削除するには D ELET E 要求が必要です。
例14 .22 ネットワークインターフェースカードからのラベルの削除
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/000000000000-0000-0000-000000000000/labels/00000000-0000-0000-0000000000000000 HTTP/1.1
HTTP/1.1 204 No Content
1 4 .7 .2 .5 . ネットワークインターフェースの統計
各ホストのネットワークインタフェースは、ホストのネットワークインターフェースの統計の
stati sti cs サブコレクションを公開します。各 stati sti c には、次のような要素が含まれます。
表14 .8 ホストのネットワークインターフェース統計の要素
要素
タイプ
説明
name
d escri pti o n
uni t
type
文字列
文字列
文字列
G AUG E または
C O UNT ER
統計エントリーの一意識別子
プレーンテキストで記述された統計の説明
統計値測定の単位またはレート
統計測定値のタイプ
135
REST API ガイド
要素
タイプ
説明
val ues type=
INT EG ER または
D EC IMAL
複合型
val ues type を参
照
リレーションシップ
その後に続く統計値のデータタイプ
val ue
d atum
ho st_ni c i d =
d atum を含むデータセット
val ue に含まれるデータの 1 つ
格納している ho st_ni c リソースとのリレーションシッ
プ
次の表には、ホスト上のネットワークインターフェースの統計タイプをまとめています。
表14 .9 ホストの N IC 統計タイプ
名前
説明
d ata. current. rx
d ata. current. tx
d ata. to tal . rx
d ata. to tal . tx
erro rs. to tal . rx
erro rs. to tal . tx
データの受信速度 (ビット毎秒)
データの送信速度 (ビット毎秒)
合計受信データ
合計送信データ
データ受信でのエラーの合計数
データ送信でのエラーの合計数
例14 .23 ホストのネットワークインターフェース統計サブコレクションの XML 表現
<statistics>
<statistic id="00000000-0000-0000-0000-000000000000"
href="/api/hosts/00000000-0000-0000-0000-000000000000/nics/
00000000-0000-0000-0000-000000000000/statistics/
00000000-0000-0000-0000-000000000000">
<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="00000000-0000-0000-0000-000000000000"
href="/api/hosts/00000000-0000-0000-0000-000000000000/nics/
00000000-0000-0000-0000-000000000000"/>
</statistic>
...
</statistics>
注記
上記の stati sti cs サブコレクションは読み取り専用です。
14 .7.3. ストレージのサブコレクション
136
⁠第1 4 章 ホスト
sto rag e サブコレクションは、ホストで使用可能な iSCSI および FCP ストレージの表現の一覧を提供し
ます。このストレージは、ストレージドメインを作成する際に使用します。
サブコレクション内の各 sto rag e の表現は SCSI LUN を表します。
例14 .24 ホスト上のストレージサブコレクションの XML 表現
<host_storage>
<storage id="82fb123b-321e-40a1-9889-95dcd2654463"
href="/api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/storage/
82fb123b-321e-40a1-9889-95dcd2654463">
<name>LUN0</name>
<type>iscsi</type>
<logical_unit id="LUN0">
<address>mysan.example.com</address>
<target>iqn.2009-08.com.example:mysan.foobar</target>
</logical_unit>
</storage>
</host_storage>
注記
ho st_sto rag e コレクションは読み取り専用です。
重要
API は、本セクションに記載した時点では試験段階にあり、今後変更される可能性があるため、後方
互換性に関する記載内容は適用されません。
14 .7.4 . ホスト NUMA ノードのサブコレクション
1 4 .7 .4 .1 . NUMA ノードのサブコレクション
numano d es サブコレクションは、ホストの NUMA トポロジーを表現します。サブコレクションの各
ho st_numa_no d e 要素は、NUMA ノードを表現します。
例14 .25 ホスト上にある N U MA ノードのサブコレクションの XML 表現
<host_numa_nodes>
<host_numa_node href="/api/hosts/f6735fa9-4ee5-47ce-b750a87863736cc2/numanodes/91d8537c-699e-460b-9a70-285f651e7d68"
id="91d8537c-699e-460b-9a70-285f651e7d68">
<link href="/api/hosts/f6735fa9-4ee5-47ce-b750a87863736cc2/numanodes/91d8537c-699e-460b-9a70-285f651e7d68/statistics"
rel="statistics"/>
<host href="/api/hosts/f6735fa9-4ee5-47ce-b750-a87863736cc2"
id="f6735fa9-4ee5-47ce-b750-a87863736cc2"/>
137
REST API ガイド
<index>0</index>
<memory>8157</memory>
<cpu>
<cores>
<core index="0"/>
<core index="2"/>
<core index="4"/>
<core index="6"/>
</cores>
</cpu>
<node_distance>10 16</node_distance>
</host_numa_node>
<host_numa_node href="/api/hosts/f6735fa9-4ee5-47ce-b750a87863736cc2/numanodes/4b18926e-6faf-43f5-9fc2-0503f1531562"
id="4b18926e-6faf-43f5-9fc2-0503f1531562">
<link href="/api/hosts/f6735fa9-4ee5-47ce-b750a87863736cc2/numanodes/4b18926e-6faf-43f5-9fc2-0503f1531562/statistics"
rel="statistics"/>
<host href="/api/hosts/f6735fa9-4ee5-47ce-b750-a87863736cc2"
id="f6735fa9-4ee5-47ce-b750-a87863736cc2"/>
<index>2</index>
<memory>8175</memory>
<cpu>
<cores>
<core index="1"/>
<core index="3"/>
<core index="5"/>
<core index="7"/>
</cores>
</cpu>
<node_distance>16 10</node_distance>
</host_numa_node>
</host_numa_nodes>
注記
上記の ho st_numa_no d es サブコレクションは読み取り専用です。
1 4 .7 .4 .2 . NUMA ノードの統計
各ホスト NUMA ノードは、NUMA ノードの統計の stati sti cs サブコレクションを公開します。各
stati sti cs には、次のような要素が含まれます。
表14 .10 ホストの N U MA ノード統計の要素
要素
タイプ
説明
name
d escri pti o n
uni t
type
文字列
文字列
文字列
G AUG E または
C O UNT ER
統計エントリーの一意識別子
プレーンテキストで記述された統計の説明
統計値測定の単位またはレート
統計測定値のタイプ
138
⁠第1 4 章 ホスト
要素
タイプ
説明
val ues type=
INT EG ER または
D EC IMAL
複合型
val ues type を参
照
リレーションシップ
その後に続く統計値のデータタイプ
val ue
d atum
ho st_numa_no d e
id=
d atum を含むデータセット
val ue に含まれるデータの 1 つ
格納している vm リソースとのリレーションシップ
以下の表には、ホストの NUMA ノードの統計タイプをまとめています。
表14 .11 ホストの N U MA ノード統計
名前
説明
memo ry. to tal
memo ry. used
memo ry. free
cpu. current. user
cpu. current. system
cpu. current. i d l e
ホスト上のメモリー合計 (バイト単位)
NUMA ノード上の使用メモリー容量 (バイト単位)
NUMA ノード上の空きメモリー容量 (バイト単位)
ユーザーの CPU 使用率
システムの CPU 使用率
アイドル時の CPU 使用率
例14 .26 ホスト N U MA ノードの統計サブコレクションの XML 表現
<statistics>
<statistic href="/api/hosts/f6745fa9-4ee5-47ce-b750a87863736cc2/numanodes/91d8537c-689e-460b-9a70285f651e7d68/statistics/7816602b-c05c-3dc7-a4da-3769f7ad8896"
id="7816602b-c05c-3dc7-a4da-3769f7ad8896">
<name>memory.total</name>
<description>Total memory</description>
<values type="INTEGER">
<value>
<datum>8157</datum>
</value>
</values>
<type>GAUGE</type>
<unit>BYTES</unit>
<host_numa_node href="/api/hosts/f6745fa9-4ee5-47ce-b750a87863736cc2/numanodes/91d8537c-689e-460b-9a70-285f651e7d68"
id="91d8537c-689e-460b-9a70-285f651e7d68"/>
</statistic>
...
</statistics>
注記
ホスト NUMA ノードの stati sti cs サブコレクションは読み取り専用です。
14 .7.5. ホスト統計のサブコレクション
139
REST API ガイド
1 4 .7 .5 .1 . ホスト統計のサブコレクション
各ホストリソースは、ホスト固有の統計の stati sti cs サブコレクションを公開します。各
stati sti cs には、次のような要素が含まれます。
表14 .12 VN IC プロファイルの要素
要素
タイプ
説明
name
d escri pti o n
uni t
type
文字列
文字列
文字列
G AUG E または
C O UNT ER
INT EG ER または
D EC IMAL
複合型
val ues type を参
照
リレーションシップ
統計エントリーの一意識別子
プレーンテキストで記述された統計の説明
統計値測定の単位またはレート
統計測定値のタイプ
val ues type=
val ue
d atum
ho st i d =
その後に続く統計値のデータタイプ
d atum を含むデータセット
val ue に含まれるデータの 1 つ
格納している ho st リソースとのリレーションシップ
次の表には、ホストの統計タイプをまとめています。
表14 .13 ホストの統計タイプ
名前
説明
memo ry. to tal
memo ry. used
memo ry. free
memo ry. shared
memo ry. buffers
memo ry. cached
swap. to tal
swap. free
swap. used
swap. cached
ホスト上のメモリー合計 (バイト単位)
ホスト上の使用メモリー容量 (バイト単位)
ホスト上の空きメモリー容量 (バイト単位)
ホストで共有されるメモリー容量 (バイト単位)
I/O バッファー (バイト単位)
OS キャッシュ (バイト単位)
ホスト上の swap メモリー容量 (バイト単位)
ホスト上の空き swap メモリー容量 (バイト単位)
ホスト上の使用 swap メモリー容量 (バイト単位)
ホストのメモリー内にもキャッシュされている swap メモリー容量
(バイト単位)
Kernel SamePage Merging (KSM) の CPU 使用率
ユーザーの CPU 使用率
システムの CPU 使用率
アイドル時の CPU 使用率
5 分あたりの CPU 負荷平均
ksm. cpu. current
cpu. current. user
cpu. current. system
cpu. current. i d l e
cpu. l o ad . avg . 5m
例14 .27 ホストの統計サブコレクションの XML 表現
<statistics>
<statistic id="4ae97794-f56d-3f05-a9e7-8798887cd1ac"
href="/api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/
statistics/4ae97794-f56d-3f05-a9e7-8798887cd1ac">
<name>memory.total</name>
<description>Total memory</description>
<unit>BYTES</unit>
<type>GUAGE</type>
14 0
⁠第1 4 章 ホスト
<values type="INTEGER">
<value>
<datum>3983540224<datum>
</value>
</values>
<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"
href="/api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</statistic>
...
</statistics>
注記
ホストの stati sti cs サブコレクションは読み取り専用です。
14 .8. アクション
14 .8.1. VDSM をインストールするアクション
ホストに VD SM および関連ソフトウェアをインストールします。ホストのタイプは、このアクションの追
加パラメーターを定義します。
R ed H at En t erp rise Lin u x ホスト: このホストタイプには、ホストのro o t ユーザー用のパスワード
を参照する ro o t_passwo rd 要素が必要です。
R ed H at En t erp rise Virt u aliz at io n H yp erviso r ホスト: このホストタイプには、Red Hat
Enterprise Virtualization Manager サーバーに格納されている ISO ファイルを参照する i mag e 要素が
必要です。
例14 .28 R ed H at En t erp rise Lin u x ホストに VD SM をインストールするアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/install HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<root_password>p@ 55w0Rd!</root_password>
</action>
例14 .29 R ed H at En t erp rise Virt u aliz at io n H yp erviso r ホストに VD SM をインストールするア
クション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/install HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<image>/usr/share/rhev-hypervisor/rhev-hypervisor.iso</image>
</action>
14 1
REST API ガイド
14 .8.2. ホストをアクティブ化するアクション
仮想マシンの実行などに使用するホストをアクティブ化します。
例14 .30 ホストをアクティブ化するアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/activate HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
14 .8.3. ホストネットワークの設定アクション
ホストで複数のネットワーク設定を構成します。setupnetwo rks アクションは、別のネットワークイン
ターフェースにネットワークを移動するなど複雑なネットワーク設定に使用することができます。
例14 .31 ホストのネットワーク設定を編集するアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/setupnetworks
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<modified_network_attachments>
<network_attachment id="41561e1c-c653-4b45-b9c9-126630e8e3b9">
<host_nic id="857a46d3-5f64-68bd-f456-c70de5b2d569"/>
</network_attachment<
<network_attachment id="3c3f442f-948b-4cdc-9a48-89bb0593cfbd">
<network id="00000000-0000-0000-0000-000000000010"/>
<ip address="10.35.1.247" netmask="255.255.254.0"
gateway="10.35.1.254"/>
<properties>
<property>
<name>bridge_opts</name>
<value>
forward_delay=1500 group_fwd_mask=0x0 multicast_snooping=1
</value>
</property>
</properties>
</network_attachment>
</modified_network_attachments>
<synchronized_network_attachments>
<network_attachment id="3c3f442f-948b-4cdc-9a48-89bb0593cfbd">
</synchronized_network_attachments>
<removed_network_attachments>
<network_attachment id="7f456dae-c57f-35d5-55a4-20b74dc53af9">
</removed_network_attachments>
<modified_bonds>
14 2
⁠第1 4 章 ホスト
<host_nic id="a56b212d-2bc4-4120-9136-53be6cacb39a">
<bonding>
<slaves>
<host_nic id="75ac21f7-4aa3-405a-a022-341e5f525b85">
<host_nic id="f3dda04c-1233-41af-a111-74327b876487">
</slaves>
</bonding>
</host_nic>
</modified_bonds>
<removed_bonds>
<host_nic id="36ab5c7f-647a-bc64-f5e7-ba5d74f8e4ba">
</removed_bonds>
<modified_labels>
<label id="Label002">
<host_nic id="857a46d3-5f64-68bd-f456-c70de5b2d569"/>
</label>
<label>
<host_nic id="a56b212d-2bc4-4120-9136-53be6cacb39a"/>
<label id="Label003/>
</label>
</modified_labels>
<removed_labels>
<label id="Label001">
</removed_labels>
<checkConnectivity>true</checkConnectivity>
<connectivityTimeout>60</connectivityTimeout>
</action>
このアクションは、標準の NIC 要素で、指定した全ホストネットワークリソースを更新します。要求に
は、以下の表に記載の追加要素が含まれます。
表14 .14 複数のホストネットワークインターフェースセットアップに対する要素
要素
タイプ
説明
mo d i fi ed _bo nd s
複合型
remo ved _bo nd s
mo d i fi ed _netwo rk_attachme
nts
複合型
複合型
synchro ni zed _netwo rk_atta
chments
複合型
ボンディングを作成または更新します。各
ho st_ni c 要素には、標準の bo nd i ng
要素が含まれます。「ボンディングイン
ターフェース」を参照してください。
削除するボンディングの ID 一覧
ホスト上のネットワークアタッチメントを
追加または更新します。各
netwo rk_attachment 要素には標準ホス
トの netwo rk_attachment 要素が含まれ
ます。「ホストのネットワークアタッチメ
ントのサブコレクション」を参照してくだ
さい。ho st_ni c ID を変更すると、異な
るネットワークインターフェースカードに
ネットワークが移動されます。
データセンターの論理ネットワーク定義と
同期する必要のあるネットワークアタッチ
メントの ID 一覧
削除するネットワークアタッチメントの ID
一覧
remo ved _netwo rk_attachment 複合型
s
14 3
REST API ガイド
要素
タイプ
説明
mo d i fi ed _l abel s
複合型
remo ved _l abel s
checkC o nnecti vi ty
複合型
ブール値
co nnecti vi tyT i meo ut
整数
ラベルを作成または変更します。各 l abel
要素には、名前または ID で識別される
l abel i d (ラベルの作成時) と
ho st_ni cが含まれます。ho st_ni c ID
は、ラベルを異なるネットワークインター
フェースカードに移動します。
削除するラベルの ID 一覧
ホストと Red Hat Enterprise
Virtualization Manager の間の接続を検証
するには、true に設定します。接続が切断
されると、Red Hat Enterprise
Virtualization Manager は設定を元に戻し
ます。
接続の切断のタイムアウトを定義します。
14 .8.4 . ホストをフェンスするアクション
API ユーザーがホストの電源管理デバイスを制御するには、fence アクションを使用します。使用可能な
fence_type オプションは、capabi l i ti es に記載されています。
例14 .32 ホストをフェンスするアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/fence
Accept: application/xml
Content-Type: application/xml
<action>
<fence_type>start</fence_type>
</action>
14 .8.5. ホストを非アクティブ化するアクション
メンテナンスタスクを実行するために、ホストを非アクティブ化します。
例14 .33 ホストを非アクティブ化するアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/deactivate HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
14 .8.6. ホストを承認するアクション
事前にインストール済みの Red Hat Enterprise Virtualization Hypervisor ホストを承認して、仮想化環境
で使用できるようにします。またこのアクションは、オプションの cl uster 要素を受け入れ、ホストの
ターゲットクラスターを定義します。
14 4
⁠第1 4 章 ホスト
例14 .34 ホストを承認するアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/approve HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<cluster id="99408929-82cf-4dc7-a532-9d998063fa95"/>
</action>
14 .8.7. ホストの iSCSI ログインのアクション
i scsi l o g i n のアクションは、ホストが iSCSI ターゲットにログインできるようにします。ターゲット
にログインすると、格納されている LUN が ho st_sto rag e コレクションで使用できるようになります
例14 .35 iSC SI ターゲットへのホストのログインを可能にするアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/iscsilogin HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<action>
<iscsi>
<address>mysan.example.com</address>
<target>iqn.2009-08.com.example:mysan.foobar</target>
<username>jimmy</username>
<password>s3kr37</password>
</iscsi>
</action>
14 .8.8. ホストの iSCSI 検出のアクション
i scsi d i sco ver のアクションは、iSCSI ポータルに対してターゲット一覧の検索クエリーを実行できる
ようにします。
例14 .36 iSC SI ポータルに対してターゲット一覧のクエリーを実行するアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/iscsidiscover
HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<action>
<iscsi>
<address>mysan.example.com</address>
<port>3260</port>
</iscsi>
</action>
14 5
REST API ガイド
14 .8.9. ネットワーク設定をコミットするアクション
API ユーザーがネットワーク設定をコミットすることにより、ホストネットワークインターフェースのア
タッチ/デタッチやボンディングインターフェースの作成/削除が永続化されます。
例14 .37 ネットワーク設定をコミットするアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/commitnetconfig
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
重要
ネットワーク設定のコミットは、設定の変更によってホストの接続が切断されていない状態である
ことを Manager が確認した上でのみ行います。ホストの接続が切断されている場合には、ホストを
再起動する必要があり、ネットワーク設定の変更は自動的に元の状態に戻ります。
14 .8.10. SPM の設定
ホストを Storage Pool Manager (SPM) として手動で設定します。
例14 .38 ホストを SPM として設定するためのアクション
POST /api/hosts/2ab5e1da-b726-4274-bbf7-0a42b16a0fc3/forceselectspm
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
14 6
⁠第1 5章 仮想マシン
第15章 仮想マシン
15.1. 仮想マシンの要素
vms コレクションは、Red Hat Enterprise Virtualization 環境内の仮想マシンに関する情報を提供します。
API ユーザーは、エントリーポイント URL から取得した rel = "vms" リンクでこの情報にアクセスしま
す。
G ET 要求に関する追加の情報は、Al l -C o ntent: true ヘッダーを使用して取得することができます。
以下の表には、仮想マシンリソースの表現に含まれる特定の要素をまとめています。
表15.1 仮想マシンの要素
要素
タイプ
説明
l i nk
rel = "appl i cat
i o ns"
l i nk
rel = "d i sks"
l i nk
rel = "ni cs"
l i nk
rel = "numano d e
s"
l i nk
rel = "cd ro ms"
l i nk
rel = "snapsho t
s"
l i nk
rel = "tag s"
l i nk
rel = "permi ssi
o ns"
l i nk
rel = "stati sti
cs"
l i nk
rel = "repo rted
d evi ces"
l i nk
rel = "watchd o g
s"
l i nk
rel = "sessi o ns
"
type
リレーションシッ
プ
リレーションシッ
プ
リレーションシッ
プ
リレーションシッ
プ
仮想マシンリソースの appl i cati o ns サブコレ
クションへのリンク。仮想マシンにインストールさ
れているアプリケーションを表示します。
仮想マシンリソースの d i sks サブコレクションへ
のリンク
仮想マシンリソースの ni cs サブコレクションへ
のリンク
仮想マシンリソースの numano d es サブコレクョ
ンへのリンク
リレーションシッ
プ
リレーションシッ
プ
仮想マシンリソースの cd ro ms サブコレクション
へのリンク
仮想マシンリソースの snapsho ts サブコレク
ションへのリンク
リレーションシッ
プ
リレーションシッ
プ
仮想マシンリソースの tag s サブコレクションへの
リンク
仮想マシンパーミッションの permi ssi o ns サブ
コレクションへのリンク
リレーションシッ
プ
仮想マシンリソースの stati sti cs サブコレク
ションへのリンク
リレーションシッ
プ
仮想マシンリソースの tag s サブコレクションへの
リンク
リレーションシッ
プ
仮想マシンリソースの watchd o g s サブコレク
ションへのリンク
リレーションシッ
プ
仮想マシンリソースの sessi o ns サブコレクショ
ンへのリンク
列挙型
仮想マシンのタイプ。列挙値の一覧は
capabi l i ti es に記載されています。
status
下記参照
仮想マシンのステータス
プロパ
ティー
14 7
REST API ガイド
要素
タイプ
説明
memo ry
整数
cpu
複合型
ゲストに割り当てられたメモリーの容量 (バイト単
位)
仮想マシンの CPU の詳細を定義しま
す。to po l o g y サブ要素は、ゲストが使用できる
論理 so ckets の数および 1 ソケットあたりのコア
数を指定します。仮想マシンが使用可能なコア数の
合計は、ソケット数に 1 ソケットあたりの co res
数を乗算した値に相当します。
cputune サブ要素は、一連の vcpupi n 要素を使
用して仮想 CPU を物理ホストの CPU にマップし
ます。各 vcpupi n 要素には仮想 CPU の属性
(vcpu) および使用する物理 ホストの CPU を定義
する属性 (cpuset) が含まれます。cpuset は、単
一の CPU (cpuset= "0 ")、複数の CPU
(cpuset= "0 ,2")、CPU 範囲 (cpuset= "0 -3")、
除外条件付きの CPU 範囲 (cpuset= "0 -3,^2")
のいずれかに指定します。
cpu_mo d e サブ要素は、仮想 CPU とホスト CPU
の関係の密接度を定義します。これには、custo m
(モードが指定されていない場合のデフォル
ト)、ho st_mo d el (libvirt が最も適切に理解でき
るようにホスト CPU をコピーす
る)、ho st_passthro ug h (libvirt が認識できなく
てもホストの全アスペクトを渡す) の 3 つの値があ
ります。ただし、ho st_passthro ug h を指定す
ると仮想マシンの移行ができなくなります。
o s bo o t d ev=
文字列 (例:
R HEL5、Wi nd o w
sXP )
列挙型
o s kernel
文字列
o s i ni trd
文字列
o s cmd l i ne
文字列
hi g h_avai l ab
i l i ty
複合型
o s type=
14 8
ゲストのオペレーティングシステムのタイプ
bo o t 要素の d ev 属性によって記述される起動デ
バイスの一覧。列挙値の一覧は capabi l i ti es
に記載されています。
仮想マシンの起動用に設定されたカーネルイメージ
へのパス。このオプションは BIOS ブートローダー
を介さない、Linux カーネルの直接のブートをサ
ポートしています。
以前に指定したカーネルで使用される initrd イメー
ジへのパス。このオプションは BIOS ブートロー
ダーを介さない、Linux カーネルの直接のブートを
サポートしています。
定義されたカーネルも使用されるカーネルコマンド
ラインパラメーターの文字列。このオプションは
BIOS ブートローダーを介さない、Linux カーネル
の直接ブートをサポートしています。
仮想マシンまたはそのホストがクラッシュした際
に、その仮想マシンを自動的に再起動するようにす
る場合は、enabl ed を true に設定しま
す。pri o ri ty 要素は、仮想マシンの再起動の順
序を制御します。
プロパ
ティー
⁠第1 5章 仮想マシン
要素
タイプ
説明
d i spl ay
複合型
ディスプレイの type (vnc または spi ce)、ポー
ト、および mo ni to rs 数。al l o w_reco nnect
のブール値は、クライアントがディスプレイを介し
て再接続可能かどうかを指定します。
プロパ
ティー
smartcard _enabl ed サブ要素は、クライアント
に接続されたスマートカードがパススルーされるか
どうかを指定するブール値 (true または fal se)
です。デフォルトは fal se です。
cl uster i d =
GUID
仮想マシンのホストクラスターへの参照
templ ate i d =
GUID
そのマシンのベースとなっているテンプレートへの
参照
d o mai n i d =
GUID
仮想マシンのドメインへの参照
start_ti me
xsd : d ateT i me
の形式: Y Y Y Y MMD D T hh: mm: ss
xsd : d ateT i me
の形式: Y Y Y Y MMD D T hh: mm: ss
xsd : d ateT i me
の形式: Y Y Y Y MMD D T hh: mm: ss
rhev、o vi rt、v
mware、xen のい
ずれか
ブール値: true また
は false
その仮想マシンを起動した日付と時刻
sto p_ti me
creati o n_ti me
o ri g i n
statel ess
d el ete_pro tec
ted
sso
pl acement_po l
i cy
その仮想マシンを終了した日付と時刻
その仮想マシンを作成した日付と時刻
その仮想マシンの元となったシステム
仮想マシンがステートレスの場合は true に指定し
ます。ステートレスの仮想マシンには、ブート時に
作成されたスナップショットが含まれ、シャット
ダウン時には削除されます。これは、再起動後に状
態が永続化されないことを意味します。
ブール値: true また true に設定した場合には、仮想マシンは削除でき
は false
ません。
文字列
仮想マシンのシングルサインオンメソッドへの参
照。i p 属性を使用する metho d 要素が含まれま
す。
複合型
仮想マシン移行の配置ポリシーを設定します。デ
フォルトの ho st= と affi ni ty
(mi g ratabl e、user_mi g ratabl e、pi nned
のいずれか) が必要です。ho st 要素を空白にする
と、優先ホストなしの設定になります。複数の
ho st 要素を使用して、クラスター内の優先ホスト
のサブセットを指定します。
14 9
REST API ガイド
要素
タイプ
説明
memo ry_po l i cy
複合型
q uo ta i d =
custo m_pro per
ti es
GUID
複合型
usb
複合型
仮想マシンのメモリーポリシーを設定します。仮想
マシンが稼働するためのホスト上の最小限の
g uaranteed メモリー容量を定義します。
仮想マシンのクォータを設定します。
パラメーターとしてカスタムのスクリプトに渡され
る、ユーザー定義の環境変数セット。各
custo m_pro perty には name および val ue の
属性が含まれます。列挙値の一覧は
capabi l i ti es に記載されています。
仮想マシンの USB ポリシーを定義しま
す。enabl ed 要素をブール値に設定し、type 要
素を nati ve または l eg acy に設定する必要があ
ります。
ライブマイグレーション中に仮想マシンを停止状態
にできる最大時間をミリ秒単位で示します。値が 0
の場合には、VD SM のデフォルトが使用されるこ
とになります。
仮想マシンの CPU プロファイルへの参照
mi g rati o n_d o w 整数
nti me
cpu_pro fi l e
id=
next_run_co nf
i g urati o n
numa_tune_mo d
e
g uest_i nfo
GUID
ブール値: true また 次回の再起動時に仮想マシンの設定の変更が適用さ
は false
れるには、true に設定します。
文字列
ホスト NUMA ノードのメモリー割り当てモードへ
(i nterl eave、stri ct、preferred のいずれ
か) の参照
複合型
ゲストクライアントの情報への参照。ad d ress=
属性を使用する i p 要素が含まれます。
vmpo o l
複合型
ti mezo ne
tz データベース形
式:
Area/Lo cati o n
複合型
d o mai n
i ni ti al i zati
on
複合型
仮想マシンプールへの参照。この要素が表示される
のは、仮想マシンがプールの一部である場合のみで
す。
Windows 仮想マシンに設定する Sysrprep タイム
ゾーン
Windows 仮想マシンのテンプレート用の Sysprep
ドメイン設定。d o mai ns コレクションからの
name が必要です。
Linux ベースの仮想マシンの場合は Cloud-Init を、
Windows ベースの仮想マシンには Sysprep を使用
して、起動時に仮想マシンに適用する値の一覧を定
義します。
C lo u d - In it
ho st_name: 仮想マシンのホスト名
ti mezo ne: 仮想マシンのタイムゾーン
user_name: 仮想マシンのユーザー名
ro o t_passwo rd : ユーザーのパスワード、ま
たはユーザーが指定されていない場合は root パ
スワード
autho ri zed _ssh_keys: 仮想マシンの認証
済みキーファイルに追加する SSH キー。改行
区切りで各 SSH を指定することで、複数の
SSH キーを入力することができます。
150
プロパ
ティー
⁠第1 5章 仮想マシン
要素
タイプ
説明reg enerate_ssh_keys: 仮想マシンの SSH
プロパ
キーを再生成するかどうか。許容値は true ま ティー
たは fal se です。
d ns_servers: スペース区切りの D NS サー
バーの一覧
d ns_search: スペース区切りの D NS 検索ド
メイン一覧
ni c_co nfi g urati o ns: 仮想マシンのネット
ワークインターフェースコントローラーを定義
します。ネットワークインターフェースコント
ローラーは、このコレクション内で
ni c_co nfi g urati o n オブジェクトとして定
義され、それぞ
れname、i p、bo o t_pro to co l 、o n_bo o t
を指定します。
custo m_scri pt: 起動時に仮想マシンで実行
するカスタムスクリプト
Sysp rep
ho st_name: 仮想マシンのホスト名
d o mai n: 仮想マシンがメンバーのドメイン
autho ri zed _ssh_keys: 仮想マシンの認証
済みキーファイルに追加する SSH キー。改行
区切りで各 SSH を指定することで、複数の
SSH キーを入力することができます。
reg enerate_ssh_keys: 仮想マシンの SSH
キーを再生成するかどうか。許容値は true ま
たは fal se です。
ti mezo ne: 仮想マシンのタイムゾーン
ro o t_passwo rd : 仮想マシンの管理ユーザー
のパスワード
custo m_scri pt: 起動時に仮想マシンで実行
するカスタムスクリプト
i nput_l o cal e: ユーザー入力のロケール
ui _l ang uag e: ボタンやメニューなどのユー
ザーインターフェースの要素に使用する言語
system_l o cal e: システム全体のロケール
user_l o cal e: ユーザーのロケール
acti ve_d i recto ry_o u: 仮想マシンが属す
る Active D irectory ドメインの組織単位
o rg _name: 仮想マシンが属する組織名
151
REST API ガイド
要素
タイプ
説明
payl o ad s
複合型
ブート時に仮想マシンにコンテンツを提供する
payl o ad 要素のセットを定義します。各
payl o ad には type 属性 (cd ro m または
fl o ppy) と fi l e 要素が必要です。各 fi l e 要素
には、ファイルの名前と場所を指定する name 要素
と、ファイルに渡すコンテンツを定義する
co ntent 要素が必要です。
プロパ
ティー
payl o ad s 要素は、cl o ud -i ni t 機能によって
使用されます。cl o ud -i ni t を使用して仮想マシ
ンを設定する場合には、type 属性が cd -ro m に指
定され、設定パラメーターを仮想マシンに渡す
o penstack/l atest/meta_d ata. jso n と
o penstack/l atest/user_d ataの 2 つの
fi l e サブ要素とともに自動的に作成されます。
status には、以下のいずれかの列挙値が含まれます:
unassi g ned 、d o wn、up、po weri ng _up、po wered _d o wn、paused 、mi g rati ng _fro m、mi g
rati ng _to 、unkno wn、no t_respo nd i ng 、wai t_fo r_l aunch、rebo o t_i n_pro g ress、savi
ng _state、resto ri ng _state、suspend ed 、i mag e_i l l eg al 、i mag e_l o cked 、po weri ng _
d o wn。これらのステータスは capabi l i ti es の下の vm_states に記載されています。
15.2. 仮想マシンの XML 表現
例15.1 仮想マシンの XML 表現
<vm id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a">
<actions>
<link rel="move"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/move"/>
<link rel="ticket"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/ticket"/>
<link rel="reboot"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/reboot"/>
<link rel="undo_snapshot"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/undo_snapshot"/>
<link rel="commit_snapshot"
href="/api/vms/70b4d9a7-4f73-4def-89ca24fc5f60e01a/commit_snapshot"/>
<link rel="preview_snapshot"
href="/api/vms/70b4d9a7-4f73-4def-89ca24fc5f60e01a/preview_snapshot"/>
<link rel="logon"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/logon"/>
<link rel="cancelmigration"
href="/api/vms/70b4d9a7-4f73-4def-89ca24fc5f60e01a/cancelmigration"/>
<link rel="maintenance"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/maintenance"/>
<link rel="clone"
152
⁠第1 5章 仮想マシン
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/clone"/>
<link rel="migrate"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/migrate"/>
<link rel="detach"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/detach"/>
<link rel="export"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/export"/>
<link rel="shutdown"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/shutdown"/>
<link rel="start"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/start"/>
<link rel="stop"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/stop"/>
<link rel="suspend"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/suspend"/>
</actions>
<name>VM_01</name>
<description>Testing Virtual Machine</description>
<link rel="applications"
href="/api/vms/70b4d9a7-4f73-4def-89ca24fc5f60e01a/applications"/>
<link rel="disks"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/disks"/>
<link rel="nics"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/nics"/>
<link rel="numanodes"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/numanodes"/>
<link rel="cdroms"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/cdroms"/>
<link rel="snapshots"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/snapshots"/>
<link rel="tags"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/tags"/>
<link rel="permissions"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/permissions"/>
<link rel="statistics"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/statistics"/>
<link rel="reporteddevices"
href="/api/vms/70b4d9a7-4f73-4def-89ca24fc5f60e01a/reporteddevices"/>
<link rel="watchdogs"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/watchdogs"/>
<link rel="sessions"
href="/api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a/sessions"/>
<type>server</type>
<status>
<state>down</state>
</status>
<memory>1073741824</memory>
<cpu>
<topology sockets="1" cores="1"/>
<architecture>X86_64</architecture>
</cpu>
<cpu_shares>0</cpu_shares>
<bios>
<boot_menu>
153
REST API ガイド
<enabled>false</enabled>
</boot_menu>
</bios>
<os type="other">
<boot dev="hd"/>
</os>
<high_availability>
<enabled>false</enabled>
<priority>1</priority>
</high_availability>
<display>
<type>spice</type>
<monitors>1</monitors>
<single_qxl_pci>false</single_qxl_pci>
<allow_override>true</allow_override>
<smartcard_enabled>false</smartcard_enabled>
<file_transfer_enabled>true</file_transfer_enabled>
<copy_paste_enabled>true</copy_paste_enabled>
</display>
<cluster href="/api/clusters/00000001-0001-0001-0001-0000000002fb"
id="00000001-0001-0001-0001-0000000002fb"/>
<template href="/api/templates/00000000-0000-0000-0000000000000000" id="00000000-0000-0000-0000-000000000000"/>
<stop_time>2014-12-03T14:25:45.588+10:00</stop_time>
<creation_time>2014-12-03T14:25:45.535+10:00</creation_time>
<origin>ovirt</origin>
<stateless>false</stateless>
<delete_protected>false</delete_protected>
<sso>
<methods>
<method id="GUEST_AGENT"/>
</methods>
</sso>
<timezone>Etc/GMT</timezone>
<placement_policy>
<affinity>migratable</affinity>
</placement_policy>
<memory_policy>
<guaranteed>1073741824</guaranteed>
</memory_policy>
<usb>
<enabled>false</enabled>
</usb>
<migration_downtime>-1</migration_downtime>
<cpu_profile href="/api/cpuprofiles/0000001a-001a-001a-001a0000000002e3" id="0000001a-001a-001a-001a-0000000002e3"/>
<next_run_configuration_exists>false</next_run_configuration_exists>
<numa_tune_mode>interleave</numa_tune_mode>
</vm>
15.3. 仮想マシンの追加 OVF データの XML 表現
154
⁠第1 5章 仮想マシン
仮想マシンの G ET 要求で Al l -C o ntent: true ヘッダーを使用して、仮想マシンの表現に追加の OVF
データを含めます。
Accept ヘッダーを空欄にした場合には、デフォルトで appl i cati o n/xml となり、XML タグに影響し
ないようにデータは HTML エンティティーで表現されます。Accept: appl i cati o n/jso n ヘッダー
を指定すると、データは標準の XML タグで返されます。以下の表現の例は、標準のブロックフォーマット
を編集して、より読みやすい書式で示しています。
例15.2 仮想マシンの追加の O VF データの XML 表現
GET /api/vms/70b4d9a7-4f73-4def-89ca-24fc5f60e01a HTTP/1.1
All-Content: true
<?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/cimschema/2/CIM_ResourceAllocationSettingData"
xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cimschema/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-90f083df133b58cc</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>
155
REST API ガイド
<TrustedService>false</TrustedService>
<OriginalTemplateId>00000000-0000-0000-0000000000000000</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 Memeory</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>
15.4 . 仮想マシンの JSON 表現
例15.3 仮想マシンの JSO N 表現
{
"type" : "server",
"status" : {
"state" : "down"
},
"stop_reason" : "",
"memory" : 1073741824,
156
⁠第1 5章 仮想マシン
"cpu" : {
"topology" : {
"sockets" : "1",
"cores" : "1"
},
"architecture" : "X86_64"
},
"cpu_shares" : "0",
"bios" : {
"boot_menu" : {
"enabled" : "false"
}
},
"os" : {
"boot" : [ {
"dev" : "hd"
} ],
"type" : "other"
},
"high_availability" : {
"enabled" : "false",
"priority" : "1"
},
"display" : {
"type" : "spice",
"monitors" : "1",
"single_qxl_pci" : "false",
"allow_override" : "false",
"smartcard_enabled" : "false",
"file_transfer_enabled" : "true",
"copy_paste_enabled" : "true"
},
"cluster" : {
"href" : "/api/clusters/00000001-0001-0001-0001-0000000002fb",
"id" : "00000001-0001-0001-0001-0000000002fb"
},
"template" : {
"href" : "/api/templates/00000000-0000-0000-0000-000000000000",
"id" : "00000000-0000-0000-0000-000000000000"
},
"stop_time" : 1423550982110,
"creation_time" : 1423490033647,
"origin" : "ovirt",
"stateless" : "false",
"delete_protected" : "false",
"sso" : {
"methods" : {
"method" : [ {
"id" : "GUEST_AGENT"
} ]
}
},
"timezone" : "Etc/GMT",
"initialization" : {
"regenerate_ssh_keys" : "false",
"nic_configurations" : { }
157
REST API ガイド
},
"placement_policy" : {
"affinity" : "migratable"
},
"memory_policy" : {
"guaranteed" : 1073741824,
"ballooning" : "true"
},
"usb" : {
"enabled" : "false"
},
"migration_downtime" : "-1",
"cpu_profile" : {
"href" : "/api/cpuprofiles/0000001a-001a-001a-001a-0000000002e3",
"id" : "0000001a-001a-001a-001a-0000000002e3"
},
"next_run_configuration_exists" : "false",
"numa_tune_mode" : "interleave",
"actions" : {
"link" : [ {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/ticket",
"rel" : "ticket"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/move",
"rel" : "move"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/clone",
"rel" : "clone"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/commit_snapshot",
"rel" : "commit_snapshot"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/preview_snapshot",
"rel" : "preview_snapshot"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/logon",
"rel" : "logon"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/cancelmigration",
"rel" : "cancelmigration"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/maintenance",
"rel" : "maintenance"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/reboot",
"rel" : "reboot"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/undo_snapshot",
"rel" : "undo_snapshot"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/migrate",
158
⁠第1 5章 仮想マシン
"rel" : "migrate"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/detach",
"rel" : "detach"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/export",
"rel" : "export"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/shutdown",
"rel" : "shutdown"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/start",
"rel" : "start"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/stop",
"rel" : "stop"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/suspend",
"rel" : "suspend"
} ]
},
"name" : "VM_01",
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e",
"id" : "42ec2621-7ad6-4ca2-bd68-973a44b2562e",
"link" : [ {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/applications",
"rel" : "applications"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/disks",
"rel" : "disks"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/nics",
"rel" : "nics"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/numanodes",
"rel" : "numanodes"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/cdroms",
"rel" : "cdroms"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/snapshots",
"rel" : "snapshots"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/tags",
"rel" : "tags"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/permissions",
"rel" : "permissions"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/statistics",
"rel" : "statistics"
}, {
159
REST API ガイド
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68973a44b2562e/reporteddevices",
"rel" : "reporteddevices"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/watchdogs",
"rel" : "watchdogs"
}, {
"href" : "/api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/sessions",
"rel" : "sessions"
} ]
}
15.5. メソッド
15.5.1. 仮想マシンの作成
新規仮想マシンの作成には name、templ ate、cl uster の要素が必要です。templ ate 要素と
cl uster 要素は i d 属性または name 要素で特定します。CPU プロファイルの ID は cpupro fi l es 属
性で特定します。
例15.4 C D - R O M から起動する、512 MB の仮想マシンの作成
POST /api/vms HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<name>vm2</name>
<description>Virtual Machine 2</description>
<type>desktop</type>
<memory>536870912</memory>
<cluster>
<name>default</name>
</cluster>
<template>
<name>Blank</name>
</template>
<os>
<boot dev="cdrom"/>
</os>
<cdroms>
<cdrom>
<file id="example_windows_7_x64_dvd_u_677543.iso"/>
</cdrom>
</cdroms>
<cpu_profile id="0000001a-001a-001a-001a-00000000035e"/>
</vm>
例15.5 仮想ハードディスクから起動する 512 MB の仮想マシンの作成
POST /api/vms HTTP/1.1
160
⁠第1 5章 仮想マシン
Accept: application/xml
Content-type: application/xml
<vm>
<name>vm2</name>
<description>Virtual Machine 2</description>
<type>desktop</type>
<memory>536870912</memory>
<cluster>
<name>default</name>
</cluster>
<template>
<name>Blank</name>
</template>
<os>
<boot dev="hd"/>
</os>
<cpu_profile id="0000001a-001a-001a-001a-00000000035e"/>
</vm>
注記
上記の例のメモリーは、以下の計算式でバイト単位に換算します。
512MB * 1024 2 = 536870912 bytes
15.5.2. 仮想マシンの更新
name、d escri pti o n、cl uster、type、memo ry、cpu、o s、hi g h_avai l abi l i ty、d i spl ay、
ti mezo ne、d o mai n、statel ess、pl acement_po l i cy、memo ry_po l i cy、usb、payl o ad s、
o ri g i n、および custo m_pro perti es の各要素は作成後に更新が可能です。
例15.6 仮想マシンの搭載メモリーを 1 G B に更新
PUT /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<memory>1073741824</memory>
</vm>
161
REST API ガイド
注記
上記の例のメモリーは、以下の計算式でバイト単位に換算します。
1024MB * 1024 2 = 1073741824 bytes
注記
メモリーのホットプラグは Red Hat Enterprise Virtualization 3.6 以降でサポートされます。上記の
例を使用して、仮想マシンの実行中にメモリーを増加することができます。
例15.7 仮想 C PU のホットプラグ
仮想マシンを再起動する必要なしに、仮想 CPU を実行中の仮想マシンに追加します。以下の例では、ソ
ケットの数は 2 に変更しています。
PUT /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<cpu>
<topology sockets="2" cores="1"/>
</cpu>
</vm>
注記
CPU のホットアンプラグは現在、Red Hat Enterprise Virtualization ではサポートされていませ
ん。
例15.8 複数のホストへの仮想マシンの固定
複数のホストに固定された仮想マシンは、ライブマイグレーションできませんが、ホストに障害が発生
した場合には、高可用性に設定された仮想マシンは、この仮想マシンが固定されている別のホスト上で再
起動されます。たとえば、複数ホストの固定を使用すると、同じハードウェア設定が指定されたホスト
だけに仮想マシンを制限することができます。
PUT /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<high_availability>
<enabled>true</enabled>
162
⁠第1 5章 仮想マシン
<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>
15.5.3. 仮想マシンの削除
仮想マシンを削除するには D ELET E 要求を実行する必要があります。
例15.9 仮想マシンの削除
DELETE /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
HTTP/1.1 204 No Content
15.5.4 . 仮想ディスクを削除せずに仮想マシンを削除する方法
仮想マシンを削除する前に仮想ディスクをデタッチしておきます。これにより、仮想ディスクが保持されま
す。仮想マシンの削除には D ELET E 要求が必要です。
例15.10 仮想マシンの削除
DELETE /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<vm>
<disks>
<detach_only>true</detach_only>
</disks>
</vm>
</action>
15.6. サブコレクション
15.6.1. ディスクのサブコレクション
1 5 .6 .1 .1 . ディスクのサブコレクション
d i sks サブコレクションは、仮想マシン上のすべての仮想ハードディスクデバイスを表します。
d i sk 表
現には次のような要素が含まれます。
163
REST API ガイド
表15.2 仮想マシンディスクの要素
要素
タイプ
説明
l i nk
rel = "stati sti cs"
リレーションシップ
仮想マシンのディスクの統計を確認す
るための stati sti cs サブコレク
ションへのリンク
permi ssi o ns サブコレクションへ
のリンク
ディスクの一意識別子。name ではな
く al i as を使用します。
定義されたストレージドメインに格納
されている仮想マシンイメージへの参
照
そのディスクと関連付けられたスト
レージドメイン。sto rag e_d o mai n
要素には 関連付けられたストレージ
ドメインの GUID を示す i d 属性が含
まれます。データストレージドメイン
間でのライブマイグレーションを実行
するには、P O ST でこの要素を更新し
ます。
ディスクサイズ (バイト単位)。非推奨
となり、pro vi si o ned _si ze に置
き換えられます。
プロビジョニングされたディスクのサ
イズ (バイト単位)
l i nk
リレーションシップ
rel = "permi ssi o ns"
al i as
文字列
i mag e_i d
文字列
sto rag e_d o mai ns
複合型
si ze
整数
pro vi si o ned _si ze
整数
actual _si ze
整数
ディスクの実際のサイズ (バイト単位)
status
i l l eg al 、i nval i d
、l o cked 、o k のいず
れか
i nterface
列挙型
fo rmat
列挙型
sparse
ブール値: true または
false
bo o tabl e
ブール値: true または
false
ディスクデバイスのステータス。 こ
れらのステータスは capabi l i ti es
の下の d i sk_states に記載されて
います。
ディスクデバイスへの接続に使用する
インターフェースドライバーのタイ
プ。使用できる列挙値の一覧は
capabi l i ti es に記載されていま
す。
下層のストレージのフォーマット。列
挙値の一覧は capabi l i ti es に記
載されています。Copy On Write
(COW) により、最小限のパフォーマ
ンスオーバーヘッドでスナップ
ショットを作成することができます。
Raw ではスナップショットは作成で
きませんが、パフォーマンスが向上し
ます。
true: 物理ストレージの場合に指定し
ます。ディスクを事前割り当てすべき
ではないためです。
true: ディスクがブート可能とマーク
されている場合に指定します。
164
プロパ
ティー
⁠ [a]
⁠第1 5章 仮想マシン
要素
タイプ
説明
shareabl e
ブール値: true または
false
ブール値: true または
false
true: 複数の仮想マシンで共有する場
合に指定します。
true: ディスクが削除される時に下層
の物理ストレージがゼロ処理される必
要がある場合に指定します。これによ
り、セキュリティーが強化されます
が、より負荷の高い操作であるため、
削除に要する時間が伸びる可能性があ
ります。
true: ディスクエラーによって仮想マ
シンが一時停止せず、代わりにディス
クエラーがゲスト OS に伝達される必
要がある場合に指定します。
格納している仮想マシンの ID
wi pe_after_d el ete
pro pag ate_erro rs
ブール値: true または
false
vm i d =
GUID
q uo ta i d =
l un_sto rag e
GUID
複合型
acti ve
ブール値
read _o nl y
ブール値
l i nk
rel = "d i sk_pro fi l
e"
リレーションシップ
プロパ
ティー
ディスククォータを設定します。
ストレージの使用状況を確認するため
の直接 LUN マッピングへの参照。
iSCSI または FCP デバイスの詳細情
報が含む l o g i cal _uni t 要素が必
要。
仮想マシンにディスクが接続されてい
るかどうかを定義します。
ディスクが読み取り専用かどうかを定
義します。
d i sk_pro fi l e サブコレクション
へのリンク
[a] この要素は、仮想マシンから作成されていないディスクを仮想マシンに追加する場合のみ必要です。
例15.11 ディスクデバイスの XML 表現
<disk id="ed7feafe-9aaf-458c-809a-ed789cdbd5b4"
href="/api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks/
ed7feafe-9aaf-458c-809a-ed789cdbd5b4">
<link rel="statistics"
href="/api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks/
ed7feafe-9aaf-458c-809a-ed789cdbd5b4/statistics"/>
<link rel="permissions"
href="/api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks/
ed7feafe-9aaf-458c-809a-ed789cdbd5b4/permissions"/>
<vm id="082c794b-771f-452f-83c9-b2b5a19c0399"
href="/api/vms/082c794b-771f-452f-83c9-b2b5a19c0399"/>
<alias>Classic_VM</alias>
<image_id>cac69a29-ccff-49d4-8a26-e4cdacd83e34</image_id>
<storage_domains>
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"/>
</storage_domains>
<size>12884901888</size>
<provisioned_size>12884901888</provisioned_size>
<actual_size>1073741824</actual_size>
165
REST API ガイド
<type>system</type>
<status>
<state>ok</state>
</status>
<interface>virtio</interface>
<format>raw</format>
<bootable>true</bootable>
<shareable>true</shareable>
<wipe_after_disk>true</wipe_after_disk>
<propagate_errors>false</propagate_errors>
<active>true</active>
<read_only>false</read_only>
<disk_profile id="23fb2e0d-3062-4819-8165-3be88f2f587e"
href="/api/diskprofiles/23fb2e0d-3062-4819-8165-3be88f2f587e"/>
<lun_storage>
<logical_unit id="lun1">
...
</logical_unit>
</lun_storage>
</disk>
新規の仮想ディスクを追加します。新しい内部ディスクを追加する場合は、pro vi si o ned _si ze 要素が
必要です。sto rag e_d o mai ns 要素を使用して、どのストレージドメインにディスクを作成するかを指定
します。異なるストレージドメインには、同じ仮想マシンに対して複数のディスクを配置することができま
す。
例15.12 仮想マシン上での新規ディスクデバイスの作成
POST /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk>
<storage_domains>
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"/>
</storage_domains>
<provisioned_size>8589934592</provisioned_size>
<type>system</type>
<interface>virtio</interface>
<format>cow</format>
<bootable>true</bootable>
</disk>
新しい外部 (直接 LUN) ディスクを仮想マシンに追加します。この方法には、l un_sto rag e 要素と、
iSCSI または FCP デバイスの詳細情報を含む l o g i cal _uni t 要素が必要です。
例15.13 仮想マシン上での新規外部 LU N ディスクデバイスの作成
POST /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks HTTP/1.1
Accept: application/xml
Content-type: application/xml
166
⁠第1 5章 仮想マシン
<disk>
<interface>virtio</interface>
<lun_storage>
<type>iscsi</type>
<logical_unit id="lun1">
<address>iscsi.example.com</address>
<port>3260</port>
<target>iqn.2010.05.com.example:iscsi.targetX</target>
</logical_unit>
</lun_storage>
</disk>
al i as、d escri pti o n、sto rag e_d o mai ns、pro vi si o ned _si ze、i nterface、bo o tabl e、
shareabl e、wi pe_after_d el ete、pro pag ate_erro rs の要素は、作成後に更新可能です。
仮想ディスクは、1 台または複数の仮想マシンにより使用されている最中でも、仮想マシンを一時停止、休
止、リブートせずにサイズの変更が可能です。
例15.14 仮想マシンディスクの更新
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/disks/ed7feafe-9aaf458c-809a-ed789cdbd5b4 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk>
<bootable>false</bootable>
<shareable>false</shareable>
</disk>
例15.15 仮想マシンディスクのサイズを 20 G B に更新
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/disks/ed7feafe-9aaf458c-809a-ed789cdbd5b4 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk>
<provisioned_size>21474836480</provisioned_size>
</disk>
注記
上記の例のディスクサイズは、以下の計算式でバイト単位に換算します。
20480MB * 1024 2 = 21474836480 bytes
167
REST API ガイド
例15.16 仮想マシンディスク名の変更
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/disks/ed7feafe-9aaf458c-809a-ed789cdbd5b4 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk>
<alias>Classic_VM2</alias>
</disk>
仮想マシンディスクを削除するには、D ELET E 要求を実行する必要があります。
例15.17 仮想マシンディスクの削除
DELETE /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/disks/ed7feafe9aaf-458c-809a-ed789cdbd5b4 HTTP/1.1
HTTP/1.1 204 No Content
1 5 .6 .1 .2 . ディスクのクローン作成
テンプレートからディスクのクローンを作成するには cl o ne 要素を使用します。仮想マシンの作成時
に、d i sks サブコレクション内の cl o ne 要素を true に設定します。これにより、ベーステンプレート
からのディスクのクローンが作成され、仮想マシンにアタッチされます。
例15.18 テンプレートからのディスクのクローン作成
次の例は、仮想マシンの作成中にテンプレートからディスクのクローンを作成します。
POST /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<name>cloned_vm</name>
<template id="64d4aa08-58c6-4de2-abc4-89f19003b886"/>
<cluster id="99408929-82cf-4dc7-a532-9d998063fa95"/>
<disks>
<clone>true</clone>
<disk id="4825ffda-a997-4e96-ae27-5503f1851d1b">
<format>COW</format>
</disk>
<disk id="42aef10d-3dd5-4704-aa73-56a023c1464c">
<format>COW</format>
</disk>
</disks>
</vm>
168
⁠第1 5章 仮想マシン
重要
ディスク名に基づいた仮想マシンの検索クエリーには、name ではなく al i as 検索パラメーターが
必要です。
1 5 .6 .1 .3. ディスク統計のサブコレクション
各仮想マシンのディスクでは、ディスク固有の統計の stati sti cs サブコレクションを公開します。各
stati sti cs には次のような要素が含まれます。
表15.3 仮想マシンディスク統計の要素
要素
タイプ
説明
name
d escri pti o n
uni t
type
文字列
文字列
文字列
G AUG E または
C O UNT ER
INT EG ER または
D EC IMAL
複合型
val ues type を参
照
リレーションシップ
統計エントリーの一意識別子
プレーンテキストで記述された統計の説明
統計値測定の単位またはレート
統計測定値のタイプ
val ues type=
val ue
d atum
d i sk i d =
その後に続く統計値のデータタイプ
d atum を含むデータセット
val ue に含まれるデータの 1 つ
格納している d i sk リソースとのリレーションシップ
次の表には、仮想マシンディスクの統計タイプをまとめています。
表15.4 仮想マシンのディスク統計タイプ
名前
説明
d ata. current. read
d ata. current. wri te
ディスク読み込み時のデータ転送速度 (バイト/秒)
ディスク書き込み時のデータ転送速度 (バイト/秒)
例15.19 仮想マシンの統計サブコレクションの XML 表現
<statistics>
<statistic id="33b9212b-f9cb-3fd0-b364-248fb61e1272"
href="/api/vms/3a42530e-3bc5-4094-829d-489257894c2a/disks/
f28ec14c-fc85-43e1-818d-96b49d50e27b/statistics/
33b9212b-f9cb-3fd0-b364-248fb61e1272">
<name>data.current.read</name>
<description>Read data rate</description>
<values type="DECIMAL">
<value>
<datum>0</datum>
</value>
</values>
<type>GAUGE</type>
<unit>BYTES_PER_SECOND</unit>
<disk id="f28ec14c-fc85-43e1-818d-96b49d50e27b"
href="/api/vms/3a42530e-3bc5-4094-829d-489257894c2a/
169
REST API ガイド
disks/f28ec14c-fc85-43e1-818d-96b49d50e27b"/>
</statistic>
...
</statistics>
注記
上記の stati sti cs サブコレクションは読み取り専用です。
1 5 .6 .1 .4 . フローティングディスクのアタッチおよびデタッチのアクション
メイン rel = "d i sks" コレクションからディスクをアタッチするには、仮想マシンのd i sks サブコレク
ションに対して P O ST 要求を実行します。その際には、アタッチするディスクの i d を指定してくださ
い。
例15.20 フローティングディスクのアタッチ
POST /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk id="d135f1c5-b5e1-4238-9381-b3277f5a3742">
</disk>
仮想マシンの d i sks サブコレクションからディスクをデタッチするには、ディスクリソースに対して
D ELET E 要求を実行します。その際には、ディスクが破棄されないように、必ずd etach のブール要素を
追加してください。
例15.21 仮想マシンからのディスクのデタッチ
DELETE /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks/
d135f1c5-b5e1-4238-9381-b3277f5a3742 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<detach>true</detach>
</action>
1 5 .6 .1 .5 . ディスクのアクティブ化および非アクティブ化のアクション
各仮想マシンのディスクは、仮想マシンにディスクを追加/削除するための acti vate および
d eacti vate アクションセットを提供します。
例15.22 仮想マシンディスクをアクティブ化するアクション
170
⁠第1 5章 仮想マシン
POST /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks/a42ada0e-1d69410d-a392-a6980d873e5d/activate HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
例15.23 仮想マシンディスクを非アクティブ化するアクション
POST /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks/a42ada0e-1d69410d-a392-a6980d873e5d/deactivate HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
これらのアクションを使用して、ディスクを仮想マシンにホットプラグし、新たにアタッチしたフロー
ティングディスクをアクティブ化します。
重要
ホットプラグ機能は、Virt IO ディスクならびにホットプラグ操作対応の仮想マシンオペレーティン
グシステムのみをサポートしています。これには、以下のようなオペレーティングシステムが含まれ
ます。
Red Hat Enterprise Linux 6
Red Hat Enterprise Linux 5
Windows Server 2008
Windows Server 2003
15.6.2. ネットワークインターフェースのサブコレクション
1 5 .6 .2 .1 . ネットワークインターフェースのサブコレクション
ni cs サブコレクションは、仮想マシン上のすべてのネットワークインターフェースデバイスを表しま
す。ni cs 表現には次の要素が含まれます。
表15.5 仮想マシンのネットワークインターフェースの要素
要素
タイプ
説明
l i nk
rel = "stati sti cs"
リレーションシップ
netwo rk i d =
GUID
仮想マシンのネットワークインター
フェース統計の stati sti cs サブコ
レクションへのリンク
インターフェースを接続すべきネット
ワークへの参照。ネットワーク ID は
空白にすることが可能。
プロパ
ティー
171
REST API ガイド
要素
タイプ
説明
i nterface
列挙型
mac ad d ress=
文字列
ネットワークインターフェースカード
に使用するドライバーのタイプ。列挙
値の一覧は capabi l i ti es にあり
ます。
インターフェースの MAC アドレス
po rt_mi rro ri ng
複合型
pl ug g ed
ブール値
l i nked
ブール値
プロパ
ティー
NIC がミラーリングされたトラフィッ
クを受信するかどうかを定義しま
す。netwo rk i d = 参照を使用して
netwo rks 要素を定義します。
NIC が仮想マシンに結線されるかどう
かを定義します。
NIC が仮想マシンにリンクされるかど
うかを定義します。
例15.24 ネットワークインターフェースの XML 表現
<nic id="7a3cff5e-3cc4-47c2-8388-9adf16341f5e"
ref="/api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/nics/
7a3cff5e-3cc4-47c2-8388-9adf16341f5e">
<link rel="statistics"
href="/api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/nics/
7a3cff5e-3cc4-47c2-8388-9adf16341f5e/statistics"/>
<name>nic1</name>
<interface>virtio</interface>
<mac address="00:1a:4a:16:84:07"/>
<network id="00000000-0000-0000-0000-000000000009"
href="/api/networks/00000000-0000-0000-0000-000000000009"/>
<vm id="cdc0b102-fbfe-444a-b9cb-57d2af94f401"
href="/api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401"/>
<port_mirroring>
<networks>
<network id="56087282-d7a6-11e1-af44-001a4a400e0c"
href="/api/networks/56087282-d7a6-11e1-af44001a4a400e0c"/>
</networks>
</port_mirroring>
</nic>
新規のネットワークインタフェースを追加する際には、name および netwo rk の要素が必要で
す。netwo rk 要素は i d 属性または name 要素で特定します。
例15.25 仮想マシン N IC の作成
POST /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/nics HTTP/1.1
Accept: application/xml
Content-type: application/xml
172
⁠第1 5章 仮想マシン
<nic>
<name>nic1</name>
<network id="00000000-0000-0000-0000-000000000009"/>
</nic>
ネットワークインターフェースを変更するには、P UT 要求を使用します。
例15.26 仮想マシン N IC の更新
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/nics/
7a3cff5e-3cc4-47c2-8388-9adf16341f5e HTTP/1.1
Accept: application/xml
Content-type: application/xml
<nic>
<name>nic2</name>
<network id="00000000-0000-0000-0000-000000000010"/>
<type>e1000</type>
</nic>
ネットワークインターフェースの削除は D ELET E 要求で行います。
例15.27 仮想マシン N IC の削除
DELETE /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/nics/
7a3cff5e-3cc4-47c2-8388-9adf16341f5e HTTP/1.1
HTTP/1.1 204 No Content
重要
ホットプラグ機能は、ホットプラグ操作対応の仮想マシンオペレーティングシステムのみをサポー
トしています。これには、以下のようなオペレーティングシステムが含まれます。
Red Hat Enterprise Linux 6
Red Hat Enterprise Linux 5
Windows Server 2008
Windows Server 2003
1 5 .6 .2 .2 . ネットワークインターフェース統計のサブコレクション
各仮想マシンのネットワークインターフェースは、ネットワークインターフェースの統計の stati sti cs
サブコレクションを公開します。各 stati sti c には、次の要素が含まれます。
表15.6 仮想マシンのネットワークインターフェース統計の要素
173
REST API ガイド
要素
タイプ
説明
name
d escri pti o n
uni t
type
文字列
文字列
文字列
G AUG E または
C O UNT ER
INT EG ER または
D EC IMAL
複合型
val ues type を参
照
リレーションシップ
統計エントリーの一意識別子
プレーンテキストで記述された統計の説明
統計値測定の単位またはレート
統計測定値のタイプ
val ues type=
val ue
d atum
ni c i d =
その後に続く統計値のデータタイプ
d atum を含むデータセット
val ue に含まれるデータの 1 つ
格納している ni c リソースとのリレーションシップ
以下の表には、仮想マシン上のネットワークインターフェースの統計タイプをまとめています。
表15.7 仮想マシンの N IC の統計タイプ
名前
説明
d ata. current. rx
d ata. current. tx
erro rs. to tal . rx
erro rs. to tal . tx
データの受信速度 (ビット毎秒)
データの送信速度 (ビット毎秒)
データ受信でのエラーの合計数
データ送信でのエラーの合計数
例15.28 仮想マシンの N IC 統計サブコレクションの XML 表現
<statistics>
<statistic id="ecd0559f-e88f-3330-94b4-1f091b0ffdf7"
href="/api/vms/3a42530e-3bc5-4094-829d-489257894c2a/nics/
6cd08e76-57c0-41ba-a728-7eba46ae1e36/statistics/
ecd0559f-e88f-3330-94b4-1f091b0ffdf7">
<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>
<nic id="6cd08e76-57c0-41ba-a728-7eba46ae1e36"
href="/api/vms/3a42530e-3bc5-4094-829d-489257894c2a/
nics/6cd08e76-57c0-41ba-a728-7eba46ae1e36"/>
</statistic>
...
</statistics>
注記
上記の stati sti cs サブコレクションは読み取り専用です。
174
⁠第1 5章 仮想マシン
15.6.3. 仮想 NUMA ノードのサブコレクション
numano d es サブコレクションは、仮想マシン上の全仮想 NUMA ノードを表します。vm_numa_no d e 表
現には次のような要素が含まれます。
表15.8 仮想 N U MA ノードの要素
要素
タイプ
説明
i nd ex
整数
仮想 NUMA ノードの指数
memo ry
整数
仮想 NUMA ノードに割り当てられた
メモリーの容量 (MB 単位)
cpu
複合型
vm i d =
GUID
この仮想 NUMA ノードに割り当てら
れた CPU トポロジー。各 co re の要
素には、コアの指数が割り当てられた
i nd ex 属性が含まれます。
格納している仮想マシンの ID
numa_no d e_pi ns
複合型
プロパ
ティー
仮想 NUMA ノードをホストの NUMA
ノードに固定します。各
numa_no d e_pi n 要素に
は、pi nned = "true" ブール値とホ
ストの NUMA ノードの i nd ex 数が
含まれます。
例15.29 仮想 N U MA ノードの XML 表現
<vm_numa_node href="/api/vms/c7ecd2dc-dbd3-4419-956f1249651c0f2b/numanodes/3290b973-ed3e-4f0b-bbf5-9be10d229e50"
id="3290b973-ed3e-4f0b-bbf5-9be10d229e50">
<index>0</index>
<memory>1024</memory>
<cpu>
<cores>
<core index="0"/>
</cores>
</cpu>
<vm href="/api/vms/c7ecd2dc-dbd3-4419-956f-1249651c0f2b"
id="c7ecd2dc-dbd3-4419-956f-1249651c0f2b"/>
<numa_node_pins>
<numa_node_pin pinned="true" index="0">
<host_numa_node id="417cdefb-8c47-4838-87f3dd0498fdf6c7"/>
</numa_node_pin>
</numa_node_pins>
</vm_numa_node>
新規仮想 NUMA ノードを追加する場合は、i nd ex、memo ry、cpu の要素が必要です。
例15.30 新規 N U MA ノードの仮想マシンへの追加
175
REST API ガイド
POST /api/vms/c7ecd2dc-dbd3-4419-956f-1249651c0f2b/numanodes HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm_numa_node>
<index>0</index>
<memory>1024</memory>
<cpu>
<cores>
<core index="0"/>
</cores>
</cpu>
</vm_numa_nodes>
仮想 NUMA ノードは P UT 要求で更新します。P UT 要求を使用して、仮想 NUMA ノードをホスト上の物理
NUMA ノードに固定することができます。
例15.31 仮想 N U MA ノードの更新
PUT /api/vms/c7ecd2dc-dbd3-4419-956f-1249651c0f2b/numanodes/3290b973ed3e-4f0b-bbf5-9be10d229e50 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm_numa_node>
<numa_node_pins>
<numa_node_pin pinned="true" index="0">
<host_numa_node id="417cdefb-8c47-4838-87f3-dd0498fdf6c7"/>
</numa_node_pin>
</numa_node_pins>
</vm_numa_node>
D ELET E 要求で仮想 NUMA ノードを削除します。
例15.32 仮想 N U MA ノードの削除
DELETE /api/vms/c7ecd2dc-dbd3-4419-956f1249651c0f2b/numanodes/3290b973-ed3e-4f0b-bbf5-9be10d229e50 HTTP/1.1
HTTP/1.1 204 No Content
15.6.4 . CD-ROM のサブコレクション
cd ro ms サブコレクションは、仮想マシン上の CD -ROM デバイスを表します。cd ro m 表現には次のエレ
メントが含まれます。
表15.9 仮想マシンの C D - R O M の要素
176
⁠第1 5章 仮想マシン
要素
タイプ
説明
fi l e i d =
文字列/ファイル名
ISO イメージへの参照
プロパ
ティー
例15.33 C D - R O M デバイスの XML 表現
<cdrom id="00000000-0000-0000-0000-000000000000"
href="/api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/
00000000-0000-0000-0000-000000000000">
<file id="rhel-server-6.0-x86_64-dvd.iso"/>
<vm id="cdc0b102-fbfe-444a-b9cb-57d2af94f401"
href="/api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401"/>
</cdrom>
新しい CD -ROM リソースを追加するには、P UT 要求を fi l e i d 要素とともに送信します。
例15.34 新規 C D - R O M ファイルの追加
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-00000000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<cdrom>
<file id="fedora-15-x86_64-dvd.iso"/>
</cdrom>
API は、P UT 要求を使用して CD -ROM を変更します。
例15.35 C D - R O M ファイルの変更
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-00000000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<cdrom>
<file id="fedora-15-x86_64-dvd.iso"/>
</cdrom>
P UT 要求に current URI 引数を追加して使用すると、API は現行セッションの CD -ROM を変更します。
例15.36 現行セッション中の C D - R O M ファイル変更
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-00000000-0000-000000000000;current=true HTTP/1.1
Accept: application/xml
Content-type: application/xml
177
REST API ガイド
<cdrom>
<file id="fedora-15-x86_64-dvd.iso"/>
</cdrom>
一時的に CD -ROM を取り出すには 仮想マシンの cd ro ms サブコレクションに P UT 要求を送信し
て、current= true マトリックスパラメーターを追加します。
例15.37 現行セッション中の C D - R O M ファイルの取り出し
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-00000000-0000-000000000000;current=true HTTP/1.1
Accept: application/xml
Content-type: application/xml
<cdrom>
<file id=""/>
</cdrom>
注記
仮想マシンをリブートすると、再度 CD -ROM が接続されます。
CD -ROM を完全に取り出すには 仮想マシンの cd ro ms サブコレクションに P UT 要求を送信します。
例15.38 C D - R O M ファイルの完全取り出し
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-00000000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<cdrom>
<file id=""/>
</cdrom>
注記
1 台の仮想マシンに含まれる CD -ROM デバイスは 1 つのみです。
15.6.5. スナップショットのサブコレクション
1 5 .6 .5 .1 . スナップショットのサブコレクション
仮想マシンは、ディスクの状態を複数のスナップショットとして保存/復元します。これらのスナップ
ショットは、rel = "snapsho t" サブコレクションで表現/管理されます。このサブコレクションは、他の
コレクションと同様に動作します。
178
⁠第1 5章 仮想マシン
各仮想マシンスナップショットは、以下のサブ要素を含む各 snapsho t 要素で表されます。
表15.10 仮想マシンのスナップショットの要素
要素
タイプ
説明
vm i d =
GUID
そのスナップショットの作成元である
仮想マシンの ID と URI
l i nk
rel = "resto re"
l i nk rel = "prev"
リレーションシップ
type
文字列
d ate
xsd : d ateT i me の形
式: Y Y Y Y -MMD D T hh: mm: ss
文字列
その仮想マシンのスナップショットを
復元するためののリンク
その仮想マシンの前のスナップショッ
トへのリンク
acti ve または reg ul ar などのス
ナップショットの種類
そのスナップショットが作成された日
付と時刻
snapsho t_status
persi st_memo rysta
te
リレーションシップ
ブール値
プロパ
ティー
スナップショットの現在のステータス
スナップショットを作成する際の仮想
マシンメモリーのステータスをスナッ
プショットに含めるかどうかを定義し
ます。
注記
スナップショットの要素の変更には P UT を使用できません。
例15.39 仮想マシンのスナップショットの XML 表現
<snapshot id="00000000-0000-0000-0000-000000000000"
href="/api/vms/00000000-0000-0000-0000-000000000000/snapshots/
00000000-0000-0000-0000-000000000000">
<actions>
<link rel="restore"
href="/api/vms/00000000-0000-0000-0000-000000000000/snapshots/
00000000-0000-0000-0000-000000000000/restore"/>
<link rel="prev"
href="/api/vms/00000000-0000-0000-0000-000000000000/snapshots/
</actions>
<vm id="00000000-0000-0000-0000-000000000000"
href="/api/vms/00000000-0000-0000-0000-000000000000"/>
<description>Virtual Machine 1 - Snapshot A</description>
<type>active</type>
<date>2010-08-16T14:24:29</date>
<snapshot_status>ok</snapshot_status>
<persist_memorystate>false</persist_memorystate>
</snapshot>
179
REST API ガイド
仮想マシンスナップショットの G ET 要求で Al l -C o ntent: true ヘッダーを使用して、スナップ
ショットの表現に追加の OVF データを含めます。
Accept ヘッダーを空欄にした場合には、デフォルトで appl i cati o n/xml となり、XML タグに影響し
ないようにデータは HTML エンティティーで表現されます。Accept: appl i cati o n/jso n ヘッダー
を指定すると、データは標準の XML タグで返されます。以下の表現の例は、標準のブロックフォーマット
を編集して、より読みやすい書式で示しています。
例15.4 0 スナップショットの追加の O VF データの XML 表現
GET /api/vms/42ec2621-7ad6-4ca2-bd68-973a44b2562e/snapshots HTTP/1.1
All-Content: true
<?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/cimschema/2/CIM_ResourceAllocationSettingData\"
xmlns:vssd=\"http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/CIM_VirtualSystemSettingData\"
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
ovf:version=\"3.5.0.0\">
<References>
<File ovf:href=\"ad353554-f668-46cf-aa3c-e57383de2c92/40456d92-36874a85-bab3-87b4cc7af459\"
ovf:id=\"40456d92-3687-4a85-bab3-87b4cc7af459\"
ovf:size=\"10737418240\"
ovf:description=\"Active VM\"/>
<Nic ovf:id=\"be14bfc8-3dbd-4ac1-ba02-c6dfa7fc707c\"/>
</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>
<Disk ovf:diskId=\"40456d92-3687-4a85-bab3-87b4cc7af459\"
ovf:size=\"10\" ovf:actual_size=\"0\"
ovf:vm_snapshot_id=\"a209216d-2909-4802-8886-02aad55dccc8\"
ovf:parentRef=\"\"
ovf:fileRef=\"ad353554-f668-46cf-aa3c-e57383de2c92/40456d92-36874a85-bab3-87b4cc7af459\"
ovf:format=\"http://www.vmware.com/specifications/vmdk.html#sparse\"
ovf:volume-format=\"RAW\"
ovf:volume-type=\"Preallocated\"
ovf:disk-interface=\"VirtIO\"
ovf:boot=\"true\"
ovf:disk-alias=\"VM_01_Disk1\"
ovf:wipe-after-delete=\"false\"/>
</Section>
<Content
ovf:id=\"out\"
xsi:type=\"ovf:VirtualSystem_Type\">
<CreationDate>2015/02/09 13:53:53</CreationDate>
<ExportDate>2015/02/10 00:39:24</ExportDate>
180
⁠第1 5章 仮想マシン
<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-90f083df133b58cc</CreatedByUserId>
<IsBootMenuEnabled>false</IsBootMenuEnabled>
<IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled>
<IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled>
<Name>VM_01</Name>
<TemplateId>00000000-0000-0000-0000-000000000000</TemplateId>
<TemplateName>Blank</TemplateName>
<IsInitilized>true</IsInitilized>
<Origin>3</Origin>
<DefaultDisplayType>1</DefaultDisplayType>
<TrustedService>false</TrustedService>
<OriginalTemplateId>00000000-0000-0000-0000000000000000</OriginalTemplateId>
<OriginalTemplateName>Blank</OriginalTemplateName>
<UseLatestVersion>false</UseLatestVersion>
<Section ovf:id=\"42ec2621-7ad6-4ca2-bd68-973a44b2562e\"
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 Memeory</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>VM_01_Disk1</rasd:Caption>
181
REST API ガイド
<rasd:InstanceId>40456d92-3687-4a85-bab387b4cc7af459</rasd:InstanceId>
<rasd:ResourceType>17</rasd:ResourceType>
<rasd:HostResource>ad353554-f668-46cf-aa3ce57383de2c92/40456d92-3687-4a85-bab3-87b4cc7af459</rasd:HostResource>
<rasd:Parent>00000000-0000-0000-0000000000000000</rasd:Parent>
<rasd:Template>00000000-0000-0000-0000000000000000</rasd:Template>
<rasd:ApplicationList></rasd:ApplicationList>
<rasd:StoragePoolId>00000002-0002-0002-0002000000000255</rasd:StoragePoolId>
<rasd:CreationDate>2015/02/09 13:54:41</rasd:CreationDate>
<rasd:LastModified>1970/01/01 00:00:00</rasd:LastModified>
<rasd:last_modified_date>2015/02/10
00:39:22</rasd:last_modified_date>
<Type>disk</Type>
<Device>disk</Device>
<rasd:Address>{slot=0x06, bus=0x00, domain=0x0000, type=pci,
function=0x0}</rasd:Address>
<BootOrder>1</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>virtio-disk0</Alias>
</Item>
<Item>
<rasd:Caption>Ethernet adapter on ovirtmgmt</rasd:Caption>
<rasd:InstanceId>be14bfc8-3dbd-4ac1-ba02c6dfa7fc707c</rasd:InstanceId>
<rasd:ResourceType>10</rasd:ResourceType>
<rasd:OtherResourceType>ovirtmgmt</rasd:OtherResourceType>
<rasd:ResourceSubType>3</rasd:ResourceSubType>
<rasd:Connection>ovirtmgmt</rasd:Connection>
<rasd:Linked>true</rasd:Linked>
<rasd:Name>nic1</rasd:Name>
<rasd:MACAddress>00:1a:4a:87:cb:00</rasd:MACAddress>
<rasd:speed>1000</rasd:speed>
<Type>interface</Type>
<Device>bridge</Device>
<rasd:Address>{slot=0x03, bus=0x00, domain=0x0000, type=pci,
function=0x0}</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>net0</Alias>
</Item>
<Item>
<rasd:Caption>USB Controller</rasd:Caption>
<rasd:InstanceId>3</rasd:InstanceId>
<rasd:ResourceType>23</rasd:ResourceType>
<rasd:UsbPolicy>DISABLED</rasd:UsbPolicy>
</Item>
<Item>
<rasd:Caption>Graphical Controller</rasd:Caption>
<rasd:InstanceId>17bbf0db-7cf0-4529-9b53dee6dee41cfd</rasd:InstanceId>
182
⁠第1 5章 仮想マシン
<rasd:ResourceType>20</rasd:ResourceType>
<rasd:VirtualQuantity>1</rasd:VirtualQuantity>
<rasd:SinglePciQxl>false</rasd:SinglePciQxl>
<Type>video</Type>
<Device>qxl</Device>
<rasd:Address>{slot=0x02, bus=0x00, domain=0x0000, type=pci,
function=0x0}</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>true</IsReadOnly>
<Alias>video0</Alias>
<SpecParams>
<vram>32768</vram>
<heads>1</heads>
</SpecParams>
</Item>
<Item>
<rasd:Caption>CDROM</rasd:Caption>
<rasd:InstanceId>7ce1bd14-d98a-43ba-beee520bdfd9c698</rasd:InstanceId>
<rasd:ResourceType>15</rasd:ResourceType>
<Type>disk</Type>
<Device>cdrom</Device>
<rasd:Address>{bus=1, controller=0, type=drive, target=0,
unit=0}</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>true</IsReadOnly>
<Alias>ide0-1-0</Alias></Item>
<Item>
<rasd:ResourceType>0</rasd:ResourceType>
<rasd:InstanceId>8758c42f-7523-461b-82bb41d91e46fd36</rasd:InstanceId>
<Type>controller</Type>
<Device>usb</Device>
<rasd:Address>{slot=0x01, bus=0x00, domain=0x0000, type=pci,
function=0x2}</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>usb0</Alias>
</Item>
<Item>
<rasd:ResourceType>0</rasd:ResourceType>
<rasd:InstanceId>58f1a596-553e-4e95-933164b5d8cebe2e</rasd:InstanceId>
<Type>controller</Type>
<Device>ide</Device>
<rasd:Address>{slot=0x01, bus=0x00, domain=0x0000, type=pci,
function=0x1}</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>ide0</Alias>
</Item>
<Item>
183
REST API ガイド
<rasd:ResourceType>0</rasd:ResourceType>
<rasd:InstanceId>2f4f8aa5-25eb-4a31-b84150dc48fce4a7</rasd:InstanceId>
<Type>channel</Type>
<Device>unix</Device>
<rasd:Address>{bus=0, controller=0, type=virtio-serial, port=1}
</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>channel0</Alias>
</Item>
<Item>
<rasd:ResourceType>0</rasd:ResourceType>
<rasd:InstanceId>edaac3ed-2ab6-48b1-ae77cc98f8b45bd8</rasd:InstanceId>
<Type>channel</Type>
<Device>unix</Device>
<rasd:Address>{bus=0, controller=0, type=virtio-serial, port=2}
</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>channel1</Alias>
</Item>
<Item>
<rasd:ResourceType>0</rasd:ResourceType>
<rasd:InstanceId>8dfed248-5164-41d3-8b6e46aef9798d84</rasd:InstanceId>
<Type>channel</Type>
<Device>spicevmc</Device>
<rasd:Address>{bus=0, controller=0, type=virtio-serial, port=3}
</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>channel2</Alias>
</Item>
<Item>
<rasd:ResourceType>0</rasd:ResourceType>
<rasd:InstanceId>d184185e-ee19-442a-88f56a48f14164e1</rasd:InstanceId>
<Type>controller</Type>
<Device>virtio-scsi</Device>
<rasd:Address>{slot=0x04, bus=0x00, domain=0x0000, type=pci,
function=0x0}</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>scsi0</Alias>
</Item>
<Item>
<rasd:ResourceType>0</rasd:ResourceType>
<rasd:InstanceId>374d219e-e2ff-4755-a544d537c87e82df</rasd:InstanceId>
<Type>controller</Type>
184
⁠第1 5章 仮想マシン
<Device>virtio-serial</Device>
<rasd:Address>{slot=0x05, bus=0x00, domain=0x0000, type=pci,
function=0x0}</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>false</IsReadOnly>
<Alias>virtio-serial0</Alias>
</Item>
<Item>
<rasd:ResourceType>0</rasd:ResourceType>
<rasd:InstanceId>cf3d7121-9db0-4fd1-bd1250ce4e1ce379</rasd:InstanceId>
<Type>balloon</Type>
<Device>memballoon</Device>
<rasd:Address>{slot=0x07, bus=0x00, domain=0x0000, type=pci,
function=0x0}</rasd:Address>
<BootOrder>0</BootOrder>
<IsPlugged>true</IsPlugged>
<IsReadOnly>true</IsReadOnly>
<Alias>balloon0</Alias>
<SpecParams>
<model>virtio</model>
</SpecParams>
</Item>
</Section>
</Content>
</ovf:Envelope>
P O ST メソッドを使用して実行中の仮想マシンのスナップショットを作成したり (ライブスナップショッ
ト)、シャットダウンしたりできます。
例15.4 1 仮想マシンのスナップショットの作成
POST /api/vms/00000000-0000-0000-0000-000000000000/snapshots/ HTTP/1.1
Accept: application/xml
Content-type: application/xml
<snapshot>
<description>Snapshot description</description>
</snapshot>
重要
OpenStack Volume (Cinder) ディスクを使用する仮想マシンのライブスナップショットを作成する
前に、ゲストのファイルシステムを手動でフリーズして解凍する必要があります。詳しい情報は「仮
想マシンのファイルシステムのフリーズアクション」と「仮想マシンのファイルシステムアクショ
ン」を参照してください。
スナップショット表現内の rel = "resto re" アクションリンクを使用して、仮想マシンのスナップショッ
トを復元することができます。
185
REST API ガイド
例15.4 2 仮想マシンのスナップショットの復元
POST /api/vms/00000000-0000-0000-0000-000000000000/snapshots/000000000000-0000-0000-000000000000/restore HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
1 5 .6 .5 .2 . スナップショットから仮想マシンのクローンを作成します。
API は、以前のマシンのスナップショットから仮想マシンを作成する機能を提供します。API ユーザーは、
すべてのスナップショットで元の仮想マシンをそのまま保持しつつ、新しい仮想マシンを作成することがで
きます。
スナップショットから仮想マシンを作成するには、仮想マシンの標準的な表現に snapsho ts 要素を追加
する必要があります。ユーザーはこの要素を P O ST 要求で vms コレクションに送信します。
snapsho ts 要素には、仮想マシンのベースとして使用する特定のスナップショットを定義する
snapsho t i d = 要素が含まれます。
例15.4 3 スナップショットからの仮想マシンのクローン作成
POST /api/vms HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
...
<snapshots>
<snapshot id="3f68ee63-0016-4f8c-9b8a-11d9f28f7c9e"/>
</snapshots>
...
</vm>
15.6.6. 統計のサブコレクション
各仮想マシンのリソースは、仮想マシン固有の統計の stati sti cs サブコレクションを公開します。各
stati sti c には次の要素が含まれます。
表15.11 仮想マシン統計の要素
要素
タイプ
説明
name
d escri pti o n
uni t
type
文字列
文字列
文字列
G AUG E または
C O UNT ER
INT EG ER または
D EC IMAL
複合型
統計エントリーの一意識別子
プレーンテキストで記述された統計の説明
統計値測定の単位またはレート
統計測定値のタイプ
val ues type=
val ue
186
その後に続く統計値のデータタイプ
d atum を含むデータセット
⁠第1 5章 仮想マシン
要素
タイプ
説明
d atum
val ues type を参
照
リレーションシップ
val ue に含まれるデータの 1 つ
vm i d =
格納している vm リソースとのリレーションシップ
以下の表には、仮想マシンの統計タイプをまとめています。
表15.12 仮想マシンの統計タイプ
名前
説明
memo ry. i nstal l ed
仮想マシンが使用するために割り当てられたメモリー合計 (バイト単
位)
仮想マシンが現在使用中のメモリー (バイト単位)
ゲストの CPU 使用率
Hypervisor 上の CPU オーバーヘッド (% )
現在の CPU 使用率合計
memo ry. used
cpu. current. g uest
cpu. current. hypervi so r
cpu. current. to tal
例15.4 4 仮想マシンの統計サブコレクションの XML 表現
<statistics>
<statistic id="ef802239-b74a-329f-9955-be8fea6b50a4"
href="/api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/
statistics/ef802239-b74a-329f-9955-be8fea6b50a4">
<name>memory.installed</name>
<description>Total memory configured</description>
<unit>BYTES</unit>
<type>GUAGE</type>
<values type="DECIMAL">
<value>
<datum>1073741824<datum>
</value>
</values>
<vm id="cdc0b102-fbfe-444a-b9cb-57d2af94f401"
href="/api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401"/>
</statistic>
...
</statistics>
注記
仮想マシンの stati sti cs サブコレクションは読み取り専用です。
15.6.7. 仮想マシンのセッション情報の表示
仮想マシンに G ET 要求を送信し、sessi o n サブコレクションを使用して、SPICE コンソールセッション
を開始したユーザーと、仮想マシンにログインしたユーザーのセッション情報を表示します。
仮想マシンの sessi o n の情報は、サブコレクションとして表示されます。
187
REST API ガイド
例15.4 5 仮想マシンのセッション情報の表示
GET /api/roles/a1a701f1-aa06-4f02-af17-158be31489b3/sessions HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<sessions>
<session id="37a6259c-c0c1-dae2-99a7-866489dff0bd"
href= "/api/vms/a1a701f1-aa06-4f02-af17158be31489b3/sessions/37a6259c-c0c1-dae2-99a7-866489dff0bd">
<vm href= "/api/vms/a1a701f1-aa06-4f02-af17-158be31489b3" id="a1a701f1aa06-4f02-af17-158be31489b3"/>
<ip address="192.0.2.0"/>
<user href= "/api/users/fdfc627c-d875-11e0-90f0-83df133b58cc"
id="fdfc627c-d875-11e0-90f0-83df133b58cc">
<domain href= "/api/domains/696e7465-726e-616c-696e-7465726e616c"
id="696e7465-726e-616c-696e-7465726e616c">
<name>internal</name>
</domain>
<user_name>admin</user_name>
</user>
<console_user>true</console_user>
</session>
<session id="37a6259c-c0c1-dae2-99a7-866489dff0bd"
href= "/api/vms/a1a701f1-aa06-4f02-af17158be31489b3/sessions/37a6259c-c0c1-dae2-99a7-866489dff0bd" >
<vm href= "/api/vms/a1a701f1-aa06-4f02-af17-158be31489b3"
id="a1a701f1-aa06-4f02-af17-158be31489b3"/>
<user>
<user_name>root</user_name>
</user>
</session>
</sessions>
15.7. アクション
15.7.1. 仮想マシンを起動するアクション
start のアクションは、停止、シャットダウン、またはサスペンドされている仮想マシンを起動します。
例15.4 6 仮想マシンを起動するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/start HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
188
⁠第1 5章 仮想マシン
起動のアクションでは、vm 要素をパラメーターとして指定できます。vm 要素が指定された場合は、仮想マ
シンは指定された要素の値を使用します (起動時のシステム設定よりも優先されます)。REST API で vm 要
素を指定して start アクションを使用する操作は、管理ポータルやユーザーポータルで 1 回実行 ウィンド
ウを使用する操作と同じです。これらの設定は、ユーザーが仮想マシンが停止するまで維持されます。たと
えば、このような要素には o s、d o mai n、pl acement_po l i cy、cd ro ms、statel ess、d i spl ay
type などが挙げられます。
例15.4 7 上書きされたパラメーターを使用して仮想マシンを起動するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/start HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<pause>true</pause>
<vm>
<stateless>true</stateless>
<display>
<type>spice</type>
</display>
<os>
<boot dev="cdrom"/>
</os>
<cdroms>
<cdrom>
<file id="windows-xp.iso"/>
</cdrom>
</cdroms>
<floppies>
<floppy>
<file id="virtio-win_x86.vfd"/>
</floppy>
</floppies>
<domain>
<name>domain.example.com</name>
<user>
<user_name>domain_user</user_name>
<password>domain_password</password>
</user>
</domain>
<placement_policy>
<host id="02447ac6-bcba-448d-ba2b-f0f453544ed2"/>
</placement_policy>
</vm>
</action>
189
REST API ガイド
注記
d o mai n 要素は、Windows システムで start のアクションでブート時にパラメーターを上書き
する場合のみ使用します。d o mai n 要素は、Windows 仮想マシンが参加するドメインを決定し
ます。そのドメインが d o mai ns コレクションに存在しない場合は、user_name や
passwo rd などの追加の user 認証情報がこの要素に必要になります。ドメインがd o mai ns
コレクションに存在する場合は、アクションに user 認証情報は追加する必要はありません。
CD イメージとフロッピーディスクファイルはすでに ISO ドメインで利用できる状態でなければ
なりません。まだ用意されていない場合は、ISO アップローダーを使用してこれらのファイルを
アップロードしてください。詳しい情報は ISO アプローダーツール を参照してください。
15.7.2. Cloud-Init アクションでの仮想マシンの起動
Cloud-Init は、仮想マシンの初期設定を自動化するツールです。このツールを使用して、ホスト名、ネット
ワークインターフェース、D NS サービス、承認キーの構成やユーザー名およびパスワードの設定を行いま
す。また、custo m_scri pt タグを使用して、起動時に仮想マシンで実行するカスタムスクリプトを指定
することも可能です。
注記
cl o ud -i ni t 要素は、cloud-init パッケージがインストールされた仮想マシンを起動する際にだけ
使用できます。cl o ud -i ni t 要素を使用する場合は、i ni ti al i zati o n 要素内にあっても
cl o ud -i ni t 要素外の要素は無視されます。
例15.4 8 C lo u d - In it を使用した仮想マシン起動アクション
以下の例では、Cloud-Init ツールを使用して仮想マシンの起動し、ホスト名の設定、root パスワードの
変更、eth0 インターフェースの静的 IP の設定、D NS の設定、ro o t ユーザーの SSH キーの追加を行
う方法が記述されています。
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/start HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<vm>
<initialization>
<cloud_init>
<host>
<address>MyHost.MyDomain.com</address>
</host>
<users>
<user>
<user_name>root</user_name>
<password>p@ 55w0rd!</password>
</user>
</users>
<network_configuration>
<nics>
190
⁠第1 5章 仮想マシン
<nic>
<name>eth0</name>
<boot_protocol>static</boot_protocol>
<network>
<ip address="192.168.122.31" netmask="255.255.255.0"
gateway="192.168.122.1"/>
</network>
<on_boot>true</on_boot>
</nic>
</nics>
<dns>
<servers>
<host>
<address>192.168.122.1</address>
</host>
</servers>
<search_domains>
<host>
<address>MyDomain.com</address>
</host>
</search_domains>
</dns>
</network_configuration>
<authorized_keys>
<authorized_key>
<user>
<user_name>root</user_name>
</user>
<key>ssh-rsa AAAAB3Nza[...]75zkdD root@ MyDomain.com</key>
</authorized_key>
</authorized_keys>
</cloud_init>
<custom_script><![CDATA[your script]]></custom_script>
</initialization>
</vm>
</action>
15.7.3. 仮想マシンを停止するアクション
stop のアクションは、仮想マシンの電源を強制的に切断します。
例15.4 9 仮想マシンを停止するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/stop HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
15.7.4 . 仮想マシンをシャットダウンするアクション
shutdown のアクションは、シャットダウン要求を仮想マシンに送信します。
191
REST API ガイド
例15.50 仮想マシンにシャットダウン要求を送信するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/shutdown HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
15.7.5. 仮想マシンを一時停止するアクション
suspend のアクションは、仮想マシンの状態をディスクに保存してから仮想マシンを停止します。サスペ
ンドされた仮想マシンを起動して仮想マシンの状態を復元するには、start アクションを使用します。
例15.51 仮想マシンの状態を保存してそのマシンを一時停止するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/suspend HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
15.7.6. 仮想マシンを再起動するアクション
reboot アクションは仮想マシンに再起動要求を送信します。
例15.52 仮想マシンに再起動要求を送信するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/reboot HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
15.7.7. 外部コンソールから仮想マシンへアクセスするためにユーザーログオンを有効にす
るアクション
logon アクションは、ユーザーが Red Hat Enterprise Virtualization 環境外のコンソールから仮想マシンに
アクセスできるようにします。
このアクションは、rhevm-guest-agent-gdm-plugin と rhevm-guest-agent-pam-module のパッケージがイン
ストールされており、o vi rt-g uest-ag ent サービスが仮想マシンで稼働されている状態でなければなり
ません。
ユーザーは、外部のコンソールから仮想マシンにアクセスするには、その仮想マシンの適切なパーミッショ
ンが必要です。
例15.53 仮想マシンへのログイン
192
⁠第1 5章 仮想マシン
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/logon HTTP/1.1
Content-Type: application/json
Content-Length: 2
{}
15.7.8. 仮想マシンをプールからデタッチするアクション
detach のアクションは、仮想マシンをプールからデタッチします。
例15.54 仮想マシンをデタッチするアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/detach HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
15.7.9. 仮想マシンを移行するアクション
migrate のアクションは、仮想マシンを別の物理ホストに移行します。Red Hat Enterprise Virtualization
Manager は、デフォルトのホストを移行先として自動的に選択するので、移行先 ho st の要素はオプショ
ンとなっています。API ユーザーが特定の ho st を必要とする場合は、i d または name いずれかのパラ
メーターでホストを指定することができます。
例15.55 別のホストに仮想マシンを移行するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/migrate HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</action>
15.7.10. 仮想マシンの移行をキャンセルするアクション
cancel migration のアクションは、他の物理ホストへの仮想マシン移行を停止します。
例15.56 他のホストへの仮想マシン移行をキャンセルするアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/cancelmigration
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
193
REST API ガイド
15.7.11. 仮想マシンをエクスポートするアクション
エクスポート操作では、仮想マシンが expo rt ストレージドメインにエクスポートされます。エクスポート
先のストレージドメインは、sto rag e_d o mai n 参照で指定する必要があります。
エクスポートのアクションは、同じ名前の仮想マシンがエクスポート先のドメインに存在する場合に、操作
が失敗したことを報告します。この動作を変更して、既存の仮想マシンを上書きするには、excl usi ve パ
ラメーターを true に設定します。
仮想マシンのスナップショットが、エクスポートされた仮想マシンに含まれない場合
は、d i scard _snapsho ts パラメーターを true に設定します。
例15.57 仮想マシンをエクスポートストレージドメインにエクスポートするアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/export HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<storage_domain>
<name>export1</name>
</storage_domain>
<exclusive>true</exclusive>
<discard_snapshots>true</discard_snapshots>
</action>
15.7.12. 仮想マシンのチケットのアクション
ticket のアクションは、仮想マシンのディスプレイにアクセスするための、時間的制約のある認証トークン
を生成します。クライアント提供の acti o n には、オプションで ti cket 表現が含まれ、val ue (トーク
ンの文字列が特定の形式を取る必要がある場合) および/または expi ry 時間 (分単位) が指定されます。い
ずれの場合も、応答には使用している実際のチケットの値と有効期限が記載されます。
例15.58 仮想マシンの認証トークンを生成するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/ticket HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<ticket>
<expiry>120</expiry>
</ticket>
</action>
200 OK
Content-Type: application/xml
<action id="94e07552-14ba-4c27-8ce6-2cc75190d3ef"
href="/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/ticket/
194
⁠第1 5章 仮想マシン
94e07552-14ba-4c27-8ce6-2cc75190d3ef">
<status>
<state>complete</state>
</status>
<ticket>
<value>5c7CSzK8Sw41</value>
<expiry>120</expiry>
</ticket>
<link rel="parent"
href="/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720"/>
<link rel="replay"
href="/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/ticket"/>
</action>
15.7.13. 仮想マシンを強制削除するアクション
障害のある仮想マシンを強制的に削除するには、fo rce のアクションを使用します。このアクションには
D ELET E メソッドが必要です。要求の本文には fo rce パラメーターを true に設定した acti o n 表現を
記載します。本文内の XML 表現を処理するには、要求に C o ntent-type: appl i cati o n/xml ヘッ
ダーを追加する必要もあります。
例15.59 仮想マシンに対する強制削除のアクション
DELETE /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<force>true</force>
</action>
15.7.14 . 仮想マシンのファイルシステムのフリーズアクション
freezefi l esystems アクションは、実行中の仮想マシンのライブスナップショットを作成する際に、
QEMU ゲストエージェントを使用して仮想マシンのファイルシステムをフリーズします。通常、これは
Manager で自動的に行われますが、OpenStack Volume (Cinder) ディスクを使用する仮想マシンには、
REST API で手動で実行する必要があります。
ゲストのオペレーティングシステム上のファイルシステムをフリーズすることでスナップショットの一貫
性を保ちます。スナップショットの作成が完了すると、ゲストのファイルシステムを解凍する必要がありま
す。OpenStack Volume ディスクを使用しない仮想マシンでは、REST API を使用して手動でフリーズお
よび解凍アクションを呼び出すこともできます。これは、スナップショットのプロセス中に失敗した場合な
どに有用な場合があります。
例15.6 0 仮想マシンのファイルシステムをフリーズするアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/freezefilesystems
HTTP/1.1
Accept: application/xml
Content-type: application/xml
195
REST API ガイド
<action/>
スナップショットに関する詳しい情報は、『Red Hat Enterprise Virtualization 仮想マシン管理ガイド』
の「スナップショットのサブコレクション」 または 「スナップショット」 のセクションを参照してくだ
さい。
15.7.15. 仮想マシンのファイルシステムアクション
thawfi l esystems アクションは、実行中の仮想マシンのライブスナップショットを作成する際に、
QEMU ゲストエージェントを使用して仮想マシンのファイルシステムを解凍します。通常、これは
Manager で自動的に行われますが、OpenStack Volume (Cinder) ディスクを使用する仮想マシンには、
REST API で手動で実行する必要があります。
ゲストのオペレーティングシステム上のファイルシステムをフリーズすることでスナップショットの一貫
性を保ちます。スナップショットの作成が完了すると、ゲストのファイルシステムを解凍する必要がありま
す。OpenStack Volume ディスクを使用しない仮想マシンでは、REST API を使用して手動でフリーズお
よび解凍アクションを呼び出すこともできます。これは、スナップショットのプロセス中に失敗した場合な
どに有用な場合があります。たとえば、仮想マシンの解凍中に応答がなくなった場合には、手動でもう一度
解凍操作を実行することができます。手動でこの操作を行わない場合には仮想マシンの応答がない状態が継
続されます。
例15.6 1 仮想マシンのファイルシステムを解凍するアクション
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/thawfilesystems
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
スナップショットに関する詳しい情報は、『Red Hat Enterprise Virtualization 仮想マシン管理ガイド』
の「スナップショットのサブコレクション」 または 「スナップショット」 のセクションを参照してくだ
さい。
196
⁠第1 6 章 フローティングディスク
第16章 フローティングディスク
16.1. フローティングディスクの要素
d i sks コレクションは Red Hat Enterprise Virtualization 環境内の全ディスクについての情報を提供しま
す。ユーザーは、ディスクと仮想マシンをアタッチ/デタッチしたり、仮想マシン間でフローティングさせ
ることができます。 API ユーザーは、エンドポイント URL から取得した rel = "d i sks" リンクでこの情
報にアクセスします。
以下の表には、d i sks リソース表現に記載される特定の要素をまとめています。
表16 .1 フローティングディスクの要素
要素
タイプ
説明
l i nk
rel = "stati sti cs"
リレーションシップ
i mag e_i d
GUID
sto rag e_d o mai ns
複合型
si ze
整数
仮想マシンのディスクの統計を確認す
るための stati sti cs サブコレク
ションへのリンク
定義されたストレージドメインに格納
されている仮想マシンイメージへの参
照
そのディスクと関連付けられたスト
レージドメイン。sto rag e_d o mai n
要素には 関連付けられたストレージ
ドメインの GUID を示す i d 属性が含
まれます。データストレージドメイン
間でのライブマイグレーションを実行
するには、P O ST でこの要素を更新し
ます。
ディスクのサイズ (バイト単位)
pro vi si o ned _si ze
整数
プロビジョニングされたディスクのサ
イズ (バイト単位)
actual _si ze
整数
ディスクの実際のサイズ (バイト単位)
status
i l l eg al 、i nval i d
、l o cked 、o k のいず
れか
i nterface
列挙型
ディスクデバイスのステータス。 こ
れらのステータスは capabi l i ti es
の下の d i sk_states に記載されて
います。
ディスクデバイスへの接続に使用する
インターフェースドライバーのタイ
プ。使用できる列挙値の一覧は
capabi l i ti es に記載されていま
す。
プロパ
ティー
197
REST API ガイド
要素
タイプ
説明
fo rmat
列挙型
sparse
ブール値: true または
false
bo o tabl e
ブール値: true または
false
ブール値: true または
false
ブール値: true または
false
下層のストレージのフォーマット。列
挙値の一覧は capabi l i ti es に記
載されています。Copy On Write
(COW) により、最小限のパフォーマ
ンスオーバーヘッドでスナップ
ショットを作成することができます。
Raw ではスナップショットは作成で
きませんが、パフォーマンスが向上し
ます。
true: 物理ストレージの場合に指定し
ます。ディスクを事前割り当てすべき
ではないためです。
true: ディスクがブート可能とマーク
されている場合に指定します。
true: 複数の仮想マシンで共有する場
合に指定します。
true: ディスクが削除される時に下層
の物理ストレージがゼロ処理される必
要がある場合に指定します。これによ
り、セキュリティーが強化されます
が、より負荷の高い操作であるため、
削除に要する時間が伸びる可能性があ
ります。
true: ディスクエラーによって仮想マ
シンが一時停止せず、代わりにディス
クエラーがゲスト OS に伝達される必
要がある場合に指定します。
ディスククォータを設定します。
ストレージの使用状況を確認するため
の直接 LUN マッピングへの参照。
iSCSI または FCP デバイスの詳細情
報が含む sto rag e 要素が必要。
仮想マシンにディスクが接続されてい
るかどうかを定義します。
shareabl e
wi pe_after_d el ete
pro pag ate_erro rs
ブール値: true または
false
q uo ta i d =
l unSto rag e
GUID
複合型
acti ve
ブール値
プロパ
ティー
重要
名前に基づいたディスクの検索クエリーには、name の代わりに al i as 検索パラメーターが必要で
す。
16.2. フローティングディスクの XML 表現
例16 .1 ディスクデバイスの XML 表現
<disk id="ed7feafe-9aaf-458c-809a-ed789cdbd5b4"
href="/api/disks/ed7feafe-9aaf-458c-809a-ed789cdbd5b4">
<link rel="statistics"
href="/api/disks/ed7feafe-9aaf-458c-809a-
198
⁠第1 6 章 フローティングディスク
ed789cdbd5b4/statistics"/>
<storage_domains>
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"/>
</storage_domains>
<size>10737418240</size>
<type>system</type>
<status>
<state>ok</state>
</status>
<interface>virtio</interface>
<format>raw</format>
<bootable>true</bootable>
<shareable>true</shareable>
<lunStorage>
<storage>
<logical_unit id="lun1">
...
</logical_unit>
<storage>
</lunStorage>
</disk>
16.3. メソッド
16.3.1. フローティングディスクの作成
新規フローティングディスクを作成する際には、API は si ze および sto rag e_d o mai ns の要素を必要
とします。
例16 .2 新規フローティングディスクデバイスの作成
POST /api/disks HTTP/1.1
Accept: application/xml
Content-type: application/xml
<disk>
<storage_domains>
<storage_domain id="fabe0451-701f-4235-8f7e-e20e458819ed"/>
</storage_domains>
<size>8589934592</size>
<type>system</type>
<interface>virtio</interface>
<format>cow</format>
</disk>
16.4 . サブコレクション
16.4 .1. 統計のサブコレクション
199
REST API ガイド
各フローティングディスクは、stati sti cs サブコレクションでディスク固有の統計を公開します。各
stati sti c には以下のような要素が含まれます。
表16 .2 仮想マシンディスク統計の要素
要素
タイプ
説明
name
d escri pti o n
uni t
type
文字列
文字列
文字列
G AUG E または
C O UNT ER
INT EG ER または
D EC IMAL
複合型
val ues type を参
照
リレーションシップ
統計エントリーの一意識別子
プレーンテキストで記述された統計の説明
統計値測定の単位またはレート
統計測定値のタイプ
val ues type=
val ue
d atum
d i sk i d =
その後に続く統計値のデータタイプ
d atum を含むデータセット
val ue に含まれるデータの 1 つ
格納している d i sk リソースとのリレーションシップ
以下の表はフローティングディスクの統計タイプについてまとめています。
表16 .3 ディスクの統計タイプ
名前
説明
d ata. current. read
d ata. current. wri te
ディスク読み込み時のデータ転送速度 (バイト/秒)
ディスク書き込み時のデータ転送速度 (バイト/秒)
例16 .3 仮想マシンの統計サブコレクションの XML 表現
<statistics>
<statistic id="33b9212b-f9cb-3fd0-b364-248fb61e1272"
href="/api/disks/f28ec14c-fc85-43e1-818d-96b49d50e27b/statistics/
33b9212b-f9cb-3fd0-b364-248fb61e1272">
<name>data.current.read</name>
<description>Read data rate</description>
<values type="DECIMAL">
<value>
<datum>0</datum>
</value>
</values>
<type>GAUGE</type>
<unit>BYTES_PER_SECOND</unit>
<disk id="f28ec14c-fc85-43e1-818d-96b49d50e27b"
href="/api/disks/f28ec14c-fc85-43e1-818d-96b49d50e27b"/>
</statistic>
...
</statistics>
注記
上記の stati sti cs サブコレクションは読み取り専用です。
200
⁠第1 6 章 フローティングディスク
16.5. アクション
16.5.1. フローティングディスクのコピー
フローティングディスクをコピーする際には、API は sto rag e_d o mai n 要素を必要とします。オプショ
ンの name 要素で、ディスクのエイリアスを指定します。
例16 .4 フローティングディスクのコピー
POST /api/disks/54a81464-b758-495a-824b-1e7937116ae5/copy HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<storage_domain id="c8e108f7-c049-40d2-ad3d-620e4638828e"/>
<disk>
<name>rhel_disk2</name>
</disk>
</action>
201
REST API ガイド
第17章 テンプレート
17.1. 仮想マシンテンプレートの要素
templ ates コレクションは、Red Hat Enterprise Virtualization 環境内の仮想マシンテンプレートに関す
る情報を提供します。API ユーザーは、エントリーポイント URL から取得した rel = "templ ates" リン
クでこの情報にアクセスします。
G ET 要求に関する追加の情報は、Al l -C o ntent: true ヘッダーを使用して取得することができます。
以下の表には、仮想マシンのテンプレートリソースの表現に含まれる特定の要素をまとめています。
表17.1 仮想マシンテンプレートの要素
要素
タイプ
l i nk rel = "d i sks"
リレーションシッ
プ
リレーションシッ
プ
リレーションシッ
プ
l i nk rel = "ni cs"
l i nk rel = "cd ro ms"
l i nk
rel = "permi ssi o ns"
type
status
memo ry
cpu
o s type=
o s bo o t d ev=
o s kernel
o s i ni trd
o s cmd l i ne
202
説明
仮想マシンテンプレートリソースの
d i sks サブコレクションのリンク
仮想マシンテンプレートリソースの
ni cs サブコレクションへのリンク
仮想マシンテンプレートリソースの
cd ro ms サブコレクションへのリン
ク
リレーションシッ 仮想マシンテンプレートパーミッショ
プ
ンの permi ssi o ns サブコレクショ
ンへのリンク
列挙型
テンプレートが提供する仮想マシンの
タイプ。列挙値の一覧は
capabi l i ti es に記載されていま
す。
i l l eg al 、l o c テンプレートのステータス。これらの
ked 、o k のいず ステータスは capabi l i ti es の下
れか
の templ ate_states に記載されて
います。
整数
ゲストに割り当てられたメモリーの容
量 (バイト単位)
複合型
ゲストが使用できる CPU to po l o g y
(so ckets 数および co res 数)
文字列 (例:
ゲストのオペレーティングシステムの
R HEL5、Wi nd o タイプ
wsXP )
列挙型
bo o t 要素の d ev 属性によって記述
される起動デバイスの一覧。 列挙値
の一覧は capabi l i ti es に記載さ
れています。
文字列
テンプレートで起動元として設定され
ているカーネルイメージへのパス
文字列
上記のカーネルと併用する initrd イ
メージへのパス
文字列
上記のカーネルと併用するカーネルコ
マンドラインパラメーターの文字列
プロパ
ティー
⁠第1 7 章 テンプレート
要素
タイプ
説明
cl uster i d =
GUID
テンプレートのホストクラスターへの
参照
vm i d =
GUID
そのテンプレートのベースとなってい
る仮想マシンへの参照
d o mai n i d =
GUID
そのテンプレートのドメインへの参照
creati o n_ti me
そのテンプレートが作成された日付と
時刻
hi g h_avai l abi l i ty
xsd : d ateT i me
の形式: Y Y Y Y MMD D T hh: mm: ss
rhev、o vi rt、
vmware、xen の
いずれか
複合型
d i spl ay
複合型
statel ess
ブール値: true ま
たは false
usb
複合型
pl acement_po l i cy
複合型
custo m_pro perti es
複合型
o ri g i n
プロパ
ティー
そのテンプレートの元となったシステ
ム
ホストがクラッシュした場合に仮想マ
シンを自動的に再起動させるに
は、enabl ed を true に設定しま
す。仮想マシンの再起動順序は
pri o ri ty 要素によって制御されま
す。
ディスプレイの type (vnc または
spi ce)、ポート、および mo ni to rs
数。al l o w_reco nnect のブール値
は、クライアントがディスプレイを介
して再接続可能かどうかを指定しま
す。
ステートレスのテンプレートには、そ
のディスクイメージのスナップ
ショットが含まれます。スナップ
ショットはブート時に作成され、
シャットダウン時に削除されるので、
状態の変更は、再起動後には無効とな
ります。
仮想マシンテンプレートの USB ポリ
シーを定義します。enabl ed 要素を
ブール値に設定し、type 要素を
nati ve または l eg acy に設定する
必要があります。
仮想マシン移行の配置ポリシーを設定
します。デフォルトの ho st= と
affi ni ty
(mi g ratabl e、user_mi g ratabl
e、pi nned のいずれか) が必要で
す。ho st 要素を空白にすると、優先
ホストなしの設定になります。
パラメーターとしてカスタムのスクリ
プトに渡される、ユーザー定義の環境
変数セット。各 custo m_pro perty
には name および val ue の属性が含
まれます。列挙値の一覧は
capabi l i ti es に記載されていま
す。
203
REST API ガイド
要素
タイプ
ti mezo ne
tz データベース形 Windows 仮想マシンテンプレートに
式:
設定する Sysrprep タイムゾーン
Area/Lo cati o
n
複合型
Windows 仮想マシンのテンプレート
用の Sysprep ドメイン設
定。d o mai ns コレクションからの
name が必要です。
d o mai n
説明
プロパ
ティー
17.2. 仮想マシンのテンプレートの XML 表現
例17.1 仮想マシンのテンプレートの XML 表現
<template href="/api/templates/00000000-0000-0000-0000-000000000000"
id="00000000-0000-0000-0000-000000000000">
<actions>
<link href="/api/templates/00000000-0000-0000-0000000000000000/export"
rel="export"/>
</actions>
<name>Blank</name>
<description>Blank template</description>
<comment>Blank template</comment>
<link href="/api/templates/00000000-0000-0000-0000000000000000/disks"
rel="disks"/>
<link href="/api/templates/00000000-0000-0000-0000000000000000/nics"
rel="nics"/>
<link href="/api/templates/00000000-0000-0000-0000000000000000/cdroms"
rel="cdroms"/>
<link href="/api/templates/00000000-0000-0000-0000000000000000/permissions"
rel="permissions"/>
<link href="/api/templates/00000000-0000-0000-0000000000000000/watchdogs"
rel="watchdogs"/>
<type>server</type>
<status>
<state>ok</state>
</status>
<memory>536870912</memory>
<cpu>
<topology sockets="1" cores="1"/>
<architecture>X86_64<architecture/>
</cpu>
<cpu_shares>0</cpu_shares>
<os type="rhel_6x64">
<boot dev="hd"/>
<boot dev="cdrom"/>;
204
⁠第1 7 章 テンプレート
</os>
<cluster id="00000000-0000-0000-0000-000000000000"
href="/api/clusters/00000000-0000-0000-0000-000000000000"/>
<creation_time>2010-08-16T14:24:29</creation_time>
<origin>ovirt</origin>
<high_availability>
<enabled>true</enabled>
<priority>100</priority>
</high_availability>
<display>
<type>spice</type>
<monitors>1</monitors>
<single_qxl_pci>false</single_qxl_pci>
<allow_override>true</allow_override>
<smartcard_enabled>true</smartcard_enabled>
</display>
<stateless>false</stateless>
<delete_protected>false</delete_protected>
<sso>
<methods>
<method id="GUEST_AGENT">true</enabled>
</methods>
</sso>
<usb>
<enabled>true</enabled>
</usb>
<migration_downtime>-1</migration_downtime>
<version>
<base_template href="/api/templates/00000000-0000-0000-0000000000000000"
id="00000000-0000-0000-0000-000000000000"/>
<version_number>2</version_number>
<version_name>RHEL65_TMPL_001</version_name>
</version>
</template>
17.3. メソッド
17.3.1. 新規のテンプレートの作成
新規テンプレートの作成には、name 要素と vm 要素が必要です。vm は i d 属性または name 要素で特定し
ます。
例17.2 仮想マシンからのテンプレート作成
POST /api/templates HTTP/1.1
Accept: application/xml
Content-type: application/xml
205
REST API ガイド
<template>
<name>template1</name>
<vm id="00000000-0000-0000-0000-000000000000"/>
</template>
17.3.2. 新しいテンプレートのサブバージョンの作成
新しいテンプレートのサブバージョンを作成するには、新規テンプレートの name と vm の要素、新規テン
プレートバージョンの base_templ ate と versi o n_name の要素が必要です。base_templ ate
とversi o n_name の要素は、templ ate セクションの versi o n セクション内に指定する必要がありま
す。i d 属性または name 要素で vm を特定します。
例17.3 仮想マシンからのテンプレートのサブバージョンの作成
POST /api/templates HTTP/1.1
Accept: application/xml
Content-type: application/xml
<template>
<name>template1_001</name>
<vm id="00000000-0000-0000-0000-000000000000"/>
<version>
<base_template id="00000000-0000-0000-0000-000000000000"/>
<version_name>"template1_001"</version_name>
</version>
</template>
17.3.3. テンプレートの更新
name、d escri pti o n、type、memo ry、cpu
to po l o g y、o s、hi g h_avai l abi l i ty、d i spl ay、statel ess、usb、ti mezo ne の要素はテン
プレート作成後に更新できます。
例17.4 仮想マシンのテンプレートのメモリーを 1 G B に更新
PUT /api/templates/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<template>
<memory>1073741824</memory>
</template>
17.3.4 . テンプレートのサブバージョンの更新
テンプレートのサブバージョンが作成されてから更新できるのは、versi o n_name 要素のみです。
例17.5 仮想マシンのテンプレートのサブバージョン名の更新
206
⁠第1 7 章 テンプレート
PUT /api/templates/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<template>
<version>
<version_name>template1_002</version_name>
</version>
</template>
17.3.5. テンプレートの削除
仮想マシンテンプレートの削除には D ELET E が必要です。
例17.6 仮想マシンテンプレートの削除
DELETE /api/templates/00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
17.4 . アクション
17.4 .1. テンプレートをエクスポートするアクション
templ ates コレクションには expo rt アクションが含まれています。
エクスポートのアクションは、テンプレートを Expo rt ストレージドメインにエクスポートします。エク
スポート先のストレージドメインは、sto rag e_d o mai n 参照で指定されます。
エクスポートのアクションは、同じ名前の仮想マシンテンプレートがエクスポート先のドメインに存在する
場合に、操作が失敗したことを報告します。この動作を変更して、既存の仮想マシンテンプレートを上書き
するには、excl usi ve パラメーターを true に設定します。
例17.7 エクスポートストレージドメインにテンプレートをエクスポートするアクション
POST /api/templates/00000000-0000-0000-0000-000000000000/export
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<storage_domain id="00000000-0000-0000-0000-000000000000"/>
<exclusive>true<exclusive/>
</action>
207
REST API ガイド
第18章 仮想マシンのプール
18.1. 仮想マシンプールの要素
vmpo o l s コレクションは、Red Hat Enterprise Virtualization 環境内の仮想マシンプールに関する情報を
提供します。API ユーザーは、エントリーポイント URL から取得した rel = "vmpo o l s" リンクでこの情
報にアクセスします。
以下の表には、仮想マシンプールのリソース表現に含まれる特定の要素をまとめています。
表18.1 仮想マシンプールの要素
要素
タイプ
説明
name
文字列
d escri pti o n
文字列
l i nk
rel = "permi ssi
o ns"
si ze
cl uster i d =
リレーションシッ
プ
ユーザーによって提供される、人間が判
読できるプール名。 name はそのタイプ
の全プールリソースで一意です。
ユーザーによって提供される、人間が判
読できる仮想マシンプールの説明
仮想マシンテンプレートプールパーミッ
ションの permi ssi o ns サブコレク
ションへのリンク
プール内の仮想マシン数
そのプール内の仮想マシンが実行してい
るクラスターリソースへの参照
templ ate i d =
GUID
整数
GUID
prestarted _vms 整数
max_user_vms
整数
プロパティー
そのプール内の仮想マシンのベースと
なっているテンプレートリソースへの参
照
仮想マシンプール内で事前に起動される
仮想マシンの数
仮想マシンプールから 1 ユーザーが取得
できる仮想マシンの最大数
重要
API は、本章に記載した時点では試験段階にあり、今後変更される可能性があるため、後方互換性に
関する記載内容は適用されません。
18.2. 仮想マシンプールの XML 表現
例18.1 仮想マシンプールの XML 表現
<vmpool href="/api/vmpools/2d2d5e26-1b6e-11e1-8cda-001320f76e8e">
id="2d2d5e26-1b6e-11e1-8cda-001320f76e8e"
<actions>
<link href="/api/vmpools/2d2d5e26-1b6e-11e1-8cda001320f76e8e/allocatevm"
rel="allocatevm"/>
</actions>
208
⁠第1 8 章 仮想マシンのプール
<name>VMPool1</name>
<description>Virtual Machine Pool 1</description>
<size>2</size>
<cluster href="/api/clusters/99408929-82cf-4dc7-a5329d998063fa95"/>
id="99408929-82cf-4dc7-a532-9d998063fa95"
<template href="/api/templates/00000000-0000-0000-0000000000000000"/>
id="00000000-0000-0000-0000-000000000000"
<prestarted_vms>0</prestarted_vms>
<max_user_vms>1</max_user_vms>
</vmpool>
18.3. メソッド
18.3.1. 新規仮想マシンプールの作成
新規のプールには name、cl uster、templ ate の各要素が必要です。cl uster および templ ate は
i d 属性または name 要素で特定します。
例18.2 仮想マシンプールの作成
POST /api/vmpools HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vmpool>
<name>VM_Pool_A</name>
<cluster href="/api/clusters/99408929-82cf-4dc7-a5329d998063fa95"/>
id="99408929-82cf-4dc7-a532-9d998063fa95"
<template href="/api/templates/00000000-0000-0000-0000000000000000"/>
id="00000000-0000-0000-0000-000000000000"
</vmpool>
18.3.2. 仮想マシンプールの更新
name、d escri pti o n、 si ze、prestarted _vms、および max_user_vms は、仮想マシンの作成後
に更新することができます。
例18.3 仮想マシンプールの更新
PUT /api/vmpools/2d2d5e26-1b6e-11e1-8cda-001320f76e8e HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vmpool>
<name>VM_Pool_B</name>
209
REST API ガイド
<description>Virtual Machine Pool B</description>
<size>3</size>
<prestarted_vms>1</size>
<max_user_vms>2</size>
</vmpool>
18.3.3. 仮想マシンプールの削除
仮想マシンを削除するには D ELET E 要求を実行する必要があります。
例18.4 仮想マシンの削除
DELETE /api/vmpools/2d2d5e26-1b6e-11e1-8cda-001320f76e8e HTTP/1.1
HTTP/1.1 204 No Content
18.4 . アクション
18.4 .1. 仮想マシンを割り当てるアクション
仮想マシンを割り当てるアクションは、仮想マシンプール内の仮想マシンを割り当てます。
例18.5 仮想マシンプールから仮想マシンを割り当てるアクション
POST /api/vmpools/2d2d5e26-1b6e-11e1-8cda-001320f76e8e/allocatevm
HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action/>
210
⁠第1 9 章 ドメイン
第19章 ドメイン
19.1. ドメインの要素
API は、d o mai ns コレクションを使用して、組織のディレクトリーサービスからユーザーおよびグループ
の情報にアクセスする機能を提供します。ドメイン情報は rel = "d o mai ns" リンクで参照します。
表19 .1 ドメインの要素
要素
タイプ
説明
name
l i nk rel = "users"
文字列
リレーションシップ
l i nk rel = "g ro ups"
リレーションシップ
ドメイン名
そのドメインに関連付けられたユーザーの
サブコレクションへのリンク
そのドメインに関連付けられたグループの
サブコレクションへのリンク
users サブコレクションおよび g ro ups サブコレクションへのリンクは、検索クエリーも受け入れます。
注記
d o mai ns コレクションとそのサブコレクションは読み取り専用です。
19.2. ドメインリソースの XML 表現
例19 .1 ドメインリソースの XML 表現
<domain id="77696e32-6b38-7268-6576-2e656e676c61"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61">
<name>domain.example.com</name>
<link rel="users"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61/users"/>
<link rel="groups"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61/groups"/>
<link rel="users/search"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61/
users?search={query}"/>
<link rel="groups/search"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61/
groups?search={query}"/>
</domain>
19.3. サブコレクション
19.3.1. ドメインユーザーのサブコレクション
users サブコレクションには、ディレクトリーサービス内の全ユーザーが含まれます。この情報は Red
Hat Enterprise Virtualization 環境に新規ユーザーを追加する際に使用されます。
211
REST API ガイド
表19 .2 ドメインユーザーの要素
要素
タイプ
説明
name
l ast_name
user_name
d o mai n i d
g ro ups
文字列
文字列
文字列
GUID
複合型
ユーザー名
ユーザーの姓
ディレクトリーサービスからのユーザー名
格納しているディレクトリーサービスドメイン
そのユーザーのディレクトリーサービスグループの
一覧
例19 .2 ユーザーサブコレクション内のユーザーの XML 表現
<user id="225f15cd-e891-434d-8262-a66808fcb9b1"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61/users/
d3b4e7be-5f57-4dac-b937-21e1771a501f">
<name>RHEV-M Admin</name>
<user_name>rhevmadmin@ domain.example.com</user_name>
<domain id="77696e32-6b38-7268-6576-2e656e676c61"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61"/>
<groups>
<group>
<name>domain.example.com/Users/Enterprise Admins</name>
</group>
<group>
<name>domain.example.com/Users/Domain Admins</name>
</group>
...
</groups>
</user>
19.3.2. ドメイングループのサブコレクション
g ro ups サブコレクションには、ディレクトリーサービス内の全グループが含まれます。ドメインg ro up
のリソースには複数の要素セットが含まれます。
表19 .3 ドメイングループの要素
要素
タイプ
説明
name
d o mai n i d
文字列
GUID
グループ名
格納しているディレクトリーサービスドメイン
例19 .3 グループサブコレクション内のグループの XML 表現
<group id="85bf8d97-273c-4a5c-b801-b17d58330dab"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61/groups/
85bf8d97-273c-4a5c-b801-b17d58330dab">
<name>example.com/Users/Enterprise Admins</name>
<domain id="77696e32-6b38-7268-6576-2e656e676c61"
href="/api/domains/77696e32-6b38-7268-6576-2e656e676c61"/>
</group>
212
⁠第2 0 章 グループ
第20章 グループ
20.1. インポートしたグループの要素
g ro ups コレクションには、ディレクトリーサービスからインポートしたグループが含まれます。
g ro up
リソースには一連の要素が含まれます。
表20.1 インポートしたグループの要素
要素
タイプ
説明
l i nk rel = "tag s"
リレーション
シップ
リレーション
シップ
リレーション
シップ
そのグループにアタッチしたタグの tag s サブコレ
クションへのリンク
そのグループにアタッチしたパーミッションの
permi ssi o ns サブコレクションへのリンク
そのグループにアタッチされたロールのro l es サ
ブコレクションへのリンク
l i nk rel = "permi ssi o ns"
l i nk rel = "ro l es"
20.2. グループリソースの XML 表現
例20.1 グループリソースの XML 表現
<group id="85bf8d97-273c-4a5c-b801-b17d58330dab"
href="/api/groups/85bf8d97-273c-4a5c-b801-b17d58330dab">
<name>Everyone</name>
<link rel="tags"
href="/api/groups/85bf8d97-273c-4a5c-b801-b17d58330dab/tags"/>
<link rel="permissions"
href="/api/groups/85bf8d97-273c-4a5c-b801b17d58330dab/permissions"/>
<link rel="roles"
href="/api/groups/85bf8d97-273c-4a5c-b801-b17d58330dab/roles"/>
<domain_entry_id>
65656530303030302D303030302D303030302D303030
</domain_entry_id>
<namespace>*</namespace>
</group>
20.3. ディレクトリーサービスからのグループの追加
API は、g ro ups コレクションに P O ST 要求を送信して、既存のディレクトリーサービスグループを Red
Hat Enterprise Virtualization Manager データベースに追加します。
例20.2 ディレクトリーサービスからのグループの追加
POST /api/group HTTP/1.1
Content-Type: application/xml
Accept: application/xml
213
REST API ガイド
<group>
<name>www.example.com/accounts/groups/mygroup</name>
<domain>
<name>example.com</name>
</domain>
</group>
214
⁠第2 1 章 ロール
第21章 ロール
21.1. ロールの要素
エントリーポイント URI から取得する rel = "ro l es" リンクを使用してシステムロールの静的なセットに
アクセスします。各 ro l e 要素には以下が含まれます。
表21.1 ロールの要素
要素
タイプ
説明
l i nk= "permi ts"
リレーションシップ
ロール permit の permi ts サブコレ
クションへのリンク
mutabl e
ブール値: true または
false
ad mi ni strati ve
ブール値: true または
false
ロールの更新/削除が可能であるかど
うかを定義します。mutabl e が
fal se に指定されたロールは、Red
Hat Enterprise Virtualization 環境に
組み込まれているロールです。
ロールを管理者限定とするかどうかを
定義します。
プロパ
ティー
21.2. ロールコレクションの XML 表現
例21.1 ロールコレクションの XML 表現
<roles>
<role id="00000000-0000-0000-0000-000000000001"
href="/api/roles/00000000-0000-0000-0000-000000000001">
<name>SuperUser</name>
<description>Roles management administrator</description>
<link rel="permits"
href="/api/roles/00000000-0000-0000-0000000000000001/permits"/>
<mutable>false</mutable>
<administrative>true</administrative>
</role>
<role id="00000000-0000-0000-0001-000000000001"
href="/api/roles/00000000-0000-0000-0001-000000000001">
<name>RHEVMUser</name>
<description>RHEVM user</description>
<link rel="permits"
href="/api/roles/00000000-0000-0000-0001000000000001/permits"/>
<mutable>false</mutable>
<administrative>false</administrative>
</role>
<role id="00000000-0000-0000-0001-000000000002"
href="/api/roles/00000000-0000-0000-0001-000000000002">
<name>RHEVMPowerUser</name>
<description>RHEVM power user</description>
<link rel="permits"
215
REST API ガイド
href="/api/roles/00000000-0000-0000-0001000000000002/permits"/>
<mutable>false</mutable>
<administrative>false</administrative>
</role>
</roles>
21.3. メソッド
21.3.1. ロールの作成
ロールの作成には、name、ad mi ni strati ve、および初期の permi ts 一覧が必要です。
例21.2 ロールの作成
POST /api/roles HTTP/1.1
Accept: application/xml
Content-type: application/xml
<role>
<name>Finance Role</name>
<administrative>true</administrative>
<permits>
<permit id="1"/>
</permits>
</role>
21.3.2. ロールの更新
name、d escri pti o n、ad mi ni strati ve の各要素は、作成後に更新が可能です。
例21.3 ロールの更新
PUT /api/roles/8de42ad7-f307-408b-80e8-9d28b85adfd7 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<role>
<name>Engineering Role</name>
<description>Standard users in the Engineering Role</description>
<administrative>false</administrative>
</role>
21.3.3. ロールの削除
ロールを削除するには、D ELET E 要求を実行する必要があります。
216
⁠第2 1 章 ロール
例21.4 ロールの削除
DELETE /api/roles/8de42ad7-f307-408b-80e8-9d28b85adfd7 HTTP/1.1
HTTP/1.1 204 No Content
21.4 . ロールの permit s のサブコレクション
21.4 .1. ロールの permit s のサブコレクション
各ロールには、許可されるアクション (permi ts) のセットが含まれ、API では、capabi l i ti es 内に記
載されています。
ロールの permi ts はサブコレクションとして記載されます。
例21.5 ロールの p ermit の一覧表示
GET /api/roles/b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9/permits HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<permits>
<permit id="1"
href="/api/roles/b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9/permits/1">
<name>create_vm</name>
<administrative>false</administrative>
<role id="b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9"
href="/api/roles/b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9"/>
</permit>
...
</permits>
21.4 .2. ロールへの permit の割り当て
permi t を割り当てるには、permi ts サブコレクションに対して P O ST 要求を実行します。i d 属性また
は name 要素を使用して割り当てる permi t を指定します。
例21.6 ロールへの p ermit の割り当て
POST /api/roles/b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9/permits HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<permit id="1"/>
HTTP/1.1 201 Created
217
REST API ガイド
Content-Type: application/xml
<permits>
<permit id="1"
href="/api/roles/b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9/permits/1">
<name>create_vm</name>
<administrative>false</administrative>
<role id="b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9"
href="/api/roles/b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9"/>
</permit>
</permits>
21.4 .3. ロールからの permit の削除
ロールから permi t を削除するには、permi t リソースに対して D ELET E 要求を実行します。
例21.7 ロールからの p ermit の削除
DELETE /api/roles/b67dfbe2-0dbc-41e4-86d3-a2fbef02cfa9/permits/1
HTTP/1.1
HTTP/1.1 204 No Content
218
⁠第2 2 章 ユーザー
第22章 ユーザー
22.1. ユーザーの要素
ユーザーはトップレベルのコレクションで公開され、rel = "users" リンクで参照されます。各 user 要素
には以下の項目が含まれます。
表22.1 ユーザーの要素
要素
タイプ
説明
user_name
文字列
l i nk rel = "tag s"
リレーションシップ
l i nk rel = "ro l es"
リレーションシップ
name
文字列
ユーザープリンシパル名 (UPN)。
UPN は、新規ユーザーを追加する際
に、より利便性の高い識別子として使
用されます。
ユーザーリソースの tag s サブコレク
ションへのリンク
ユーザーリソースの ro l es サブコレ
クションへのリンク
自由形式のユーザー名
d o mai n
文字列
格納しているディレクトリーサービス
ドメイン
g ro ups
複合型
そのユーザーのディレクトリーサービ
スグループの一覧
プロパ
ティー
22.2. ユーザーリソースの XML 表現
例22.1 ユーザーリソースの XML 表現
GET /api/users HTTP/1.1
Accept: application/xml
<user id="225f15cd-e891-434d-8262-a66808fcb9b1"
href="/api/users/225f15cd-e891-434d-8262-a66808fcb9b1">
<name>RHEV-M Admin</name>
<actions/>
<link rel="roles"
href="/api/users/225f15cd-e891-434d-8262-a66808fcb9b1/roles"/>
<link rel="tags"
href="/api/users/225f15cd-e891-434d-8262-a66808fcb9b1/tags"/>
<domain>domain.example.com</domain>
<logged_in>false</logged_in>
<user_name>rhevmadmin@ domain.example.com</user_name>
<groups>
<group>Group Policy Creator
Owners@ domain.example.com/Users</group>
<group>Domain Admins@ domain.example.com/Users</group>
<group>Enterprise Admins@ domain.example.com/Users</group>
219
REST API ガイド
<group>Schema Admins@ domain.example.com/Users</group>
<group>Administrators@ domain.example.com/Builtin</group>
</groups>
</user>
22.3. メソッド
22.3.1. ユーザーの追加
API は、users コレクションへの P O ST 要求を使用して 既存のディレクトリーサービスのユーザーを Red
Hat Enterprise Virtualization Manager のデータベースに追加します。新規ユーザーの表現には 埋め込ま
れた ro l es の一覧が含まれ、ユーザーに割り当てるための初期ro l e が少なくとも 1 つ記載されていま
す。たとえば、以下の要求は、2 つの初期ロールをユーザー jo e@ d o mai n. exampl e. co m に割り当てま
す。
例22.2 ディレクトリーサービスからのユーザーと 2 つのロールの割り当て
POST /api/users HTTP/1.1
Content-Type: application/xml
Accept: application/xml
<user>
<user_name>joe@ domain.example.com</user_name>
<roles>
<role>
<name>RHEVMPowerUser</name>
</role>
<role id="00000000-0000-0000-0001-000000000003"/>
</roles>
</user>
新規ユーザーは、Red Hat Enterprise Virtualization Manager ユーザー ID またはディレクトリーサービス
のユーザープリンシパル名 (UPN) のいずれかで特定します。ディレクトリーサービスドメインから報告さ
れるユーザー ID の形式は、LD IF ⁠ [5] などの Red Hat Enterprise Virtualization Manager で想定される形
式とは異なる可能性があり、その場合には、ID のバイト順が逆で base-64 エンコードされています。した
がって、通常は UPN で新規ユーザーを参照する方が便利です。
注記
Red Hat Enterprise Virtualization Manager のデータベースにユーザーを追加する前に、そのユー
ザーがディレクトリーサービスドメインに存在している必要があります。API ユーザーは、ユーザー
作成の前に d o mai ns コレクションでこのドメインにクエリーを実行するオプションを使用するこ
とができます。
ロールは、名前または ID のいずれかで特定します。上記では、両方を方法を示しています。
22.3.2. ユーザーへのロールの追加
追加のロールをアタッチまたはデタッチする場合は、各ユーザーのロールのサブコレクションに対して
220
⁠第2 2 章 ユーザー
P O ST または D ELET E 要求を実行します。 以下の例では、R HEVMVD IUser ロールを特定ユーザーのロー
ル割り当てに追加する方法を示しています。
注記
user の埋め込まれたユーザーロール一覧は、初回の作成時にのみ使用されます。作成後のユーザー
ロール割り当てとの対話は、ro l es サブコレクションを通して行われます。
例22.3 ユーザーへのロールの追加
POST /api/users/225f15cd-e891-434d-8262-a66808fcb9b1/roles HTTP/1.1
Content-Type: application/xml
Accept: application/xml
<role>
<name>RHEVMVDIUser</name>
</role>
[5] LDAP Data Interc hang e Fo rmat については RFC 28 49 に説明が記載されています。
221
REST API ガイド
第23章 タグ
23.1. タグの要素
tag s コレクションは、Red Hat Enterprise Virtualization 環境内のタグに関する情報を提供します。API
ユーザーは、エントリーポイント URL から取得した rel = "tag s" リンクでこの情報にアクセスします。
次の表には、タグリソースの表現内に含まれる特定の要素をまとめています。
表23.1 タグの要素
要素
タイプ
説明
ho st
GUID
タグがアタッチされているホストへの
参照
user
GUID
タグがアタッチされているユーザーへ
の参照
vm
GUID
タグがアタッチされている仮想マシン
への参照
parent
複合型
タグがアタッチされている仮想マシン
への参照
プロパ
ティー
23.2. タグリソースの XML 表現
例23.1 タグリソースの XML 表現
<tag id="f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e"
href="/api/tags/f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e">
<name>Finance</name>
<description>Resources for the Finance department</description>
<parent>
<tag id="-1" href="/api/tags/-1"/>
</parent>
</tag>
23.3. タグの関連付け
23.3.1. ホスト、ユーザー、仮想マシンへのタグの関連付け
ho st、user、または vms の l i nk rel = "tag s" によって参照されるコレクションは、そのエンティ
ティーに関連付けられたタグセットを示します。
これらの tag 表現には、対象となるエンティティーへの ho st i d 、user i d 、vm i d 参照も含まれま
す。
エンティティーへのタグの関連付けは、コレクションに対してタグ参照を P O ST (i d または name のいず
れかでタグを特定) することによって行います。
222
⁠第2 3章 タグ
例23.2 仮想マシンへのタグの関連付け
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/tags HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<tag>
<name>Finance</name>
</tag>
HTTP/1.1 201 Created
Content-Type: application/xml
<tag id="f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e"
href="/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/tags/
f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e">
<name>Finance</name>
<description>Resources for the Finance department</description>
<vm id="5114bb3e-a4e6-44b2-b783-b3eea7d84720"
href="/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720"/>
</tag>
23.3.2. タグの削除
タグの関連付けを削除するには、コレクション内の適切な要素に対して D ELET E 要求を実行します。
例23.3 仮想マシンからのタグ削除
DELETE /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/tags/f436ebfc-67f241bd-8ec6-902b6f7dcb5e HTTP/1.1
HTTP/1.1 204 No Content
23.3.3. タグ付けしたリソースのコレクションに対するクエリーの実行
特定のタグに関連付けられたリソースセットに対してクエリーを実行する場合は、適切なコレクションの
co l l ecti o n/search URI テンプレートを使用して tag = MyT ag に一致するエンティティーの検索を行
います。
例23.4 タグ付けしたリソースのコレクションに対するクエリーの実行
GET /api/vms?search=tag%3DFinance HTTP/1.1
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<vms>
<vm id="5114bb3e-a4e6-44b2-b783-b3eea7d84720"
href="/api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720">
223
REST API ガイド
...
</vm>
...
</vms>
23.4 . 親タグ
23.4 .1. 親タグ
API ユーザーは、parent 要素をタグに割り当てて親タグに対して階層リンクを作成することができます。
タグは、ro o t タグを基点とする非階層的なコレクションとして表示されます。各タグ表現には親タグへの
リンク要素が含まれます。
注記
ro o t タグは、親タグが指定されていない場合にはデフォルトの親タグと仮定される特殊な擬似タグ
です。ro o t タグは削除したり、親タグを割り当てることはできません。
このタグは次のように表現します。
例23.5 タグの階層
<tags>
<tag id="-1" href="/api/tags/-1">
<name>root</name>
<description>root</description>
<parent>
<tag id="-1" href="/api/tags/-1"/>
</parent>
</tag>
<tag id="f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e"
href="/api/tags/f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e">
<name>Finance</name>
<description>Resources for the Finance department</description>
<parent>
<tag id="-1" href="/api/tags/-1"/>
</parent>
</tag>
<tag id="ac18dabf-23e5-12be-a383-a38b165ca7bd"
href="/api/tags/ac18dabf-23e5-12be-a383-a38b165ca7bd">
<name>Billing</name>
<description>Billing Resources</description>
<parent>
<tag id="f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e"
href="/api/tags/f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e"/>
</parent>
</tag>
</tags>
この XML 表現では、タグの階層は以下のようになります。
224
⁠第2 3章 タグ
root
- Finance
- Billing
(id: -1)
(id: f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e)
(id: ac18dabf-23e5-12be-a383-a38b165ca7bd)
23.4 .2. 親タグの設定
parent 要素を指定した新規タグを P O ST すると、親タグに関連付けられます。これには、i d 属性または
name 要素を使用します。
例23.6 ID 属性を使用した親タグとの関連付けの設定
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/tags HTTP/1.1
Accept: application/xml
Content-Type: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<tag>
<name>Billing</name>
<description>Billing Resources</description>
<parent>
<tag id="f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e"/>
</parent>
</tag>
例23.7 n ame 要素を使用した親タグとの関連付けの設定
POST /api/vms/5114bb3e-a4e6-44b2-b783-b3eea7d84720/tags HTTP/1.1
Accept: application/xml
Content-Type: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
<tag>
<name>Billing</name>
<description>Billing Resources</description>
<parent>
<tag>
<name>Finance</name>
</tag>
</parent>
</tag>
23.4 .3. 親タグの変更
親の変更はタグで P UT 要求を使用して行います。
225
REST API ガイド
例23.8 親タグの変更
PUT /api/tags/ac18dabf-23e5-12be-a383-a38b165ca7bd HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<tag>
<parent>
<tag id="f436ebfc-67f2-41bd-8ec6-902b6f7dcb5e"/>
</parent>
</tag>
226
⁠第2 4 章 イベント
第24章 イベント
24 .1. イベントの要素
エントリーポイント URI から取得した rel = "events" リンクは events コレクションにアクセスし、
Red Hat Enterprise Virtualization Manager からのシステムイベントを表示します。
表24 .1 イベントの要素
要素
タイプ
説明
d escri pti o n
co d e
severi ty
システムイベントの説明
整数型のイベントコード
イベントの重大度レベル
co rrel ati o n_i d
文字列
整数
no rmal 、warni n
g 、erro r、al er
t のいずれか
xsd : d ateT i me
の形式: Y Y Y Y MMD D T hh: mm: ss
文字列
user i d =
o ri g i n
GUID
文字列
custo m_i d
整数
fl o o d _rate
整数
external _status
複合型
ti me
イベントが発生した日時を示すタイムスタンプ
Red Hat Enterprise Virtualization の複数の層にま
たがるアクションの ID 文字列
イベントをトリガーしたユーザーの ID コード
イベントのソース。標準のイベントはo Vi rt によ
りレポートされます。
カスタムイベントのカスタムの ID 番号。標準イベ
ントの custo m_i d は -1 です。
イベント一覧内に同じイベントが再発できないよう
にする時間 (秒)。デフォルトの値は、30 です。
ホストの外部ヘルスステータス。これにはstate
要素が含まれており、この要素には
o k、i nfo 、erro r、warni ng 、fai l ure のい
ずれかを指定することができます。
24 .2. イベントコレクションの XML 表現
例24 .1 イベントコレクションの XML 表現
<events>
<event id="537" href="/api/events/537">
<description>User vdcadmin logged in.</description>
<code>30</code>
<severity>normal</severity>
<time>2011-01-12T10:48:27.827+02:00</time>
<user id="9b9002d1-ec33-4083-8a7b-31f6b8931648"
href="/api/users/9b9002d1-ec33-4083-8a7b-31f6b8931648"/>
</event>
...
</events>
227
REST API ガイド
24 .3. 仮想マシン作成イベントの XML 表現
event 表現には、user に加えて、イベントに関連したリソースに対する XML 要素のリレーションシップ
も記載されます。
例24 .2 仮想マシン作成イベントの XML 表現
<event id="635" href="/api/events/635">
<description>VM bar was created by rhevadmin.</description>
<code>34</code>
<severity>normal</severity>
<time>2011-07-11T16:32:03.172+02:00</time>
<user id="4621b611-43eb-4d2b-ae5f-1180850268c4"
href="/api/users/4621b611-43eb-4d2b-ae5f-1180850268c4"/>
<vm id="9b22d423-e16b-4dd8-9c06-c8e9358fbc66"
href="/api/vms/9b22d423-e16b-4dd8-9c06-c8e9358fbc66"/>
<storage_domain id="a8a0e93d-c570-45ab-9cd6-3c68ab31221f"
href="/api/storagedomains/a8a0e93d-c570-45ab-9cd6-3c68ab31221f"/>
</event>
上記の表現は、仮想マシンリソースおよびストレージドメインリソースに対するXML 要素のリレーショ
ンシップを示した例です。
24 .4 . メソッド
24 .4 .1. イベントの検索
events コレクションは、他のリソースコレクションと同様の検索クエリーを提供します。events コレク
ションを検索する際には、特定のイベント以降のイベントを検索する追加機能があります。これにより、指
定されたイベント以降の全イベントに対するクエリーを実行することができます。
イベントからクエリーを実行するには、検索クエリーの前に fro m パラメーターを追加する必要がありま
す。この fro m 引数はイベント i d コードを参照します。
例24 .3 指定したイベント以降のイベントを対象とする検索
GET /api/events;from=1012?search=type%3D30 HTTP/1.1
Accept: application/xml
i d = "10 12" 以降で、type が 30 に指定されたイベントをすべて表示します。
HTTP/1.1 200 OK
Content-Type: application/xml
<events>
<event id="1018" href="/api/events/1018">
<description>User admin logged in.</description>
<code>30</code>
<severity>normal</severity>
<time>2011-07-11T14:03:22.485+10:00</time>
<user id="80b71bae-98a1-11e0-8f20-525400866c73"
href="/api/users/80b71bae-98a1-11e0-8f20-525400866c73"/>
228
⁠第2 4 章 イベント
</event>
<event id="1016" href="/api/events/1016">
<description>User admin logged in.</description>
<code>30</code>
<severity>normal</severity>
<time>2011-07-11T14:03:07.236+10:00</time>
<user id="80b71bae-98a1-11e0-8f20-525400866c73"
href="/api/users/80b71bae-98a1-11e0-8f20-525400866c73"/>
</event>
<event id="1014" href="/api/events/1014">
<description>User admin logged in.</description>
<code>30</code>
<severity>normal</severity>
<time>2011-07-11T14:02:16.009+10:00</time>
<user id="80b71bae-98a1-11e0-8f20-525400866c73"
href="/api/users/80b71bae-98a1-11e0-8f20-525400866c73"/>
</event>
</events>
例24 .4 特定のイベント重大度を使用した検索
GET /api/events?search=severity>normal HTTP/1.1
Accept: application/xml
重大度が no rmal を超えるすべてのイベントを表示します。重大度のレベルには
no rmal 、warni ng 、erro r、および al ert があります。
HTTP/1.1 200 OK
Content-Type: application/xml
<events>
<event id="2823" href="/api/events/2823">
<description>Host Host-05 has time-drift of 36002 seconds while
maximum configured value is 300 seconds.</description>
<code>604</code>
<severity>warning</severity>
<time>2015-07-11T14:03:22.485+10:00</time>
<host href= "/api/hosts/44e52bb2-27d6-4d35-8038-0c4b4db89789"
id="44e52bb2-27d6-4d35-8038-0c4b4db89789"/>
<cluster href= "/api/clusters/00000001-0001-0001-000100000000021b" id="00000001-0001-0001-0001-00000000021b"/>
<origin>oVirt</origin>
<custom_id>-1</custom_id>
<flood_rate>30</flood_rate>
</event>
...
</events>
24 .4 .2. イベントのページネーション処理
仮想化環境では、一定時間が経過すると、大量のイベントが生成されますが、API は 1 回の検索でデフォル
ト数のイベントしか表示しません。デフォルト数以上のイベント数を表示するには、検索クエリーに pag e
コマンドを使用すると、API が結果を複数のページに分割します。
229
REST API ガイド
以下の検索クエリーは、pag e 値を so rtby と併用して、結果をページネーションするように API に指示
します。
so rtby ti me asc pag e 1
so rtby 句は、結果を昇順または降順に順序付けするためのベース要素を定義します。events の検索クエ
リーの場合は、ベース要素を ti me に、順序を昇順 (asc) に指定すると、API は仮想化環境の作成以降の全
イベントを表示します。
pag e 条件はページ数を定義します。1 ページは、表示するイベントのデフォルト数に相当します。ページ
ネーションは pag e 1 から開始します。さらにページを表示するには、pag e 値を増やします。
so rtby ti me asc pag e 2
so rtby ti me asc pag e 3
so rtby ti me asc pag e 4
例24 .5 イベントのページネーション
以下の例は event リソースのページネーションを行います。URL エンコードされた要求は次のとおりで
す。
GET /api/events?search=sortby%20time%20asc%20page%201 HTTP/1.1
Accept: application/xml
pag e 値を増やして次の結果ページを表示します。
GET /api/events?search=sortby%20time%20asc%20page%202 HTTP/1.1
Accept: application/xml
fro m 引数を追加し、開始する i d を指定します。
GET /api/events?search=sortby%20time%20asc%20page%202& from=30 HTTP/1.1
Accept: application/xml
24 .4 .3. イベントの追加
API では、P O ST 要求でカスタムイベントを events コレクションに追加することができます。新規イベ
ントには、 d escri pti o n、severi ty、o ri g i n、custo m_i d 要素が必要です。カスタムイベントに
は、イベントに関連するリソースの fl o o d _rate、user i d 、i d のコードを含めることも可能で
す。ho st および sto rag e_d o mai n 要素に external _status を含めて、外部のヘルスステータスを
設定することも可能です。
例24 .6 カスタムイベントのイベント一覧への追加
POST /api/events HTTP/1.1
Accept: application/xml
Content-type: application/xml
<event>
<description>The heat of the host is above 30 Oc</description>
<severity>warning</severity>
230
⁠第2 4 章 イベント
<origin>HP Openview</origin>
<custom_id>1</custom_id>
<flood_rate>30</flood_rate>
<host id="f59a29cd-587d-48a3-b72a-db537eb21957" >
<external_status>
<state>warning</state>
</external_status>
</host>
</event>
24 .4 .4 . イベントの削除
イベント一覧からイベントを削除するには、D ELET E 要求が必要になります。
例24 .7 イベントの削除
DELETE /api/events/1705 HTTP/1.1
HTTP/1.1 204 No Content
231
REST API ガイド
付録A cURL での API の使用法
A.1. cURL での API の使用法
本付録では、REST の要求を cU R L での使用に適合させる方法について説明します。cU R L は、HTTP な
ど各種プロトコルでデータを転送するためのコマンドラインツールです。Linux、Windows、Mac、
Solaris など複数のプラットフォームに対応しています。大半の Linux のディストリビューションには
cU R L がパッケージとして同梱されています。
A.2. cURL のインストール
Red Hat Enterprise Linux ユーザーの場合は、以下のターミナルコマンドで cU R L をインストールしま
す。
yum i nstal l curl
その他のプラットフォームの場合には、cU R L の Web サイトでインストール方法を確認してください
(http://curl.haxx.se/)。
A.3. cURL の使用法
cU R L は、コマンドラインインターフェースを使用して HTTP サーバーに要求を送信します。要求を統合
するには、以下のコマンド構文が必要です。
curl [options] uri
uri はターゲットの HTTP アドレスを参照し、要求を送信します。これは API エントリーポイントパス内
の Red Hat Enterprise Virtualization Manager ホスト上の場所です (/api )。
cU R L のオプション
- X COMMAND, - - req u est COMMAND
使用する要求コマンド。REST API では、G ET 、P O ST 、P UT 、D ELET E のいずれかを使用しま
す。
-X G ET
- H LINE, - - h ead er LINE
要求に追加する HTTP ヘッダー。ヘッダーが複数必要な場合は、複数のヘッダーオプションを使
用します。
例: -H "Accept: appl i cati o n/xml " -H "C o ntent-T ype: appl i cati o n/xml "
- u USERNAME:PASSWORD, - - u ser USERNAME:PASSWORD
Red Hat Enterprise Virtualization ユーザーのユーザー名とパスワード。この属性は
Autho ri zati o n: ヘッダーの便利な代替手段として機能します。
例: -u ad mi n@ i nternal : p@ 55w0 rd !
- - cacert CERTIFICATE
232
⁠付録A cURL での API の使用法
REST API との SSL 通信のための証明書ファイルの場所。証明書ファイルはクライアントマシン
上にローカルで保存されます。SSL をバイパスする場合は -k 属性を使用します。
例: --cacert ~ /C erti fi cates/rhevm. cer
- d BODY, - - d at a BODY
送信する要求の本文。P O ST 、P UT 、D ELET E などの要求で使用します。要求内に本文が存在す
る場合は、C o ntent-T ype: appl i cati o n/xml を必ず指定してください。
例: -d "<cd ro m><fi l e i d = ' rhel -server-6 . 0 -x86 _6 4 -d vd . i so ' /></cd ro m>"
A.4 . 例
A.4 .1. cURL を使用した GET 要求
例A.1 G ET 要求
以下の G ET 要求は、vms コレクション内の仮想マシンを一覧表示します。G ET 要求には本文が含まれ
ない点に注意してください。
GET /api/vms HTTP/1.1
Accept: application/xml
メソッド (G ET )、ヘッダー (Accept: appl i cati o n/xml )、URI (https: //[RHEVMHost]: 4 4 3/api /vms) を次の cU R L コマンドに適用します。
$ curl -X GET -H "Accept: application/xml" -u [USER:PASS] --cacert
[CERT] https://[RHEVM-Host]:443/api/vms
vms コレクションの XML 表現が表示されます。
A.4 .2. cURL を使用した POST 要求
例A.2 P O ST 要求
次の P O ST 要求は、vms コレクション内に仮想マシンを作成します。P O ST 要求には本文が必要な点に
注意してください。
POST /api/vms HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<name>vm1</name>
<cluster>
<name>default</name>
</cluster>
<template>
<name>Blank</name>
</template>
233
REST API ガイド
<memory>536870912</memory>
<os>
<boot dev="hd"/>
</os>
</vm>
メソッド (P O ST )、ヘッダー (Accept: appl i cati o n/xml および C o ntent-type:
appl i cati o n/xml )、 URI (https: //[RHEVM-Host]: 4 4 3/api /vms)、要求の本文を次の cU R L
コマンドに適用します。
$ curl -X POST -H "Accept: application/xml" -H "Content-type:
application/xml" -u [USER:PASS] --cacert [CERT] -d "<vm>
<name>vm1</name><cluster><name>default</name></cluster><template>
<name>Blank</name></template><memory>536870912</memory><os><boot
dev='hd'/></os></vm>" https://[RHEVM-Host]:443/api/vms
REST API は新規仮想マシンを作成し、そのリソースの XML 表現を表示します。
A.4 .3. cURL を使用した PUT 要求
例A.3 P UT 要求
以下の P UT 要求は、仮想マシンリソースのメモリーを更新します。P UT 要求には本文が必要な点に注意
してください。
PUT /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<vm>
<memory>1073741824</memory>
</vm>
メソッド (P UT )、ヘッダー (Accept: appl i cati o n/xml と C o ntent-type:
appl i cati o n/xml )、URI (https: //[RHEVM-Host]: 4 4 3/api /vms/0 82c79 4 b-771f4 52f-83c9 -b2b5a19 c0 39 9 )、要求の本文を次の cU R L コマンドに適用します。
$ curl -X PUT -H "Accept: application/xml" -H "Content-type:
application/xml" -u [USER:PASS] --cacert [CERT] -d "<vm>
<memory>1073741824</memory></vm>" https://[RHEVMHost]:443//api/vms/082c794b-771f-452f-83c9-b2b5a19c039
REST API は新しいメモリー設定で仮想マシンを更新します。
A.4 .4 . cURL を使用した DELET E 要求
例A.4 D ELET E 要求
以下の D ELET E 要求は、仮想マシンのリソースを削除します。
234
⁠付録A cURL での API の使用法
DELETE /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
メソッド (D ELET E) および URI (https: //[RHEVM-Host]: 4 4 3/api /vms/0 82c79 4 b-771f4 52f-83c9 -b2b5a19 c0 39 9 ) を次の cU R L コマンドに適用します。
$ curl -X DELETE -u [USER:PASS] --cacert [CERT] https://[RHEVMHost]:443//api/vms/082c794b-771f-452f-83c9-b2b5a19c039
REST API は仮想マシンを削除します。D ELET E 要求の結果が空のため、Accept:
appl i cati o n/xml ヘッダーはオプションになります。
A.4 .5. cURL を使用した 本文付きの DELET E 要求
例A.5 本文付きの D ELET E 要求
以下の D ELET E 要求は、オプションの本文で示されているように、仮想マシンリソースを強制削除しま
す。
DELETE /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399 HTTP/1.1
Accept: application/xml
Content-type: application/xml
<action>
<force>true</force>
</action>
メソッド (D ELET E)、ヘッダー (Accept: appl i cati o n/xml および C o ntent-type:
appl i cati o n/xml )、URI (https: //[RHEVM-Host]: 4 4 3/api /vms/0 82c79 4 b-771f4 52f-83c9 -b2b5a19 c0 39 9 )、要求の本文を次の cU R L コマンドに適用します。
$ curl -X DELETE -H "Accept: application/xml" -H "Content-type:
application/xml" -u [USER:PASS] --cacert [CERT] -d "<action>
<force>true</force></action>" https://[RHEVMHost]:443//api/vms/082c794b-771f-452f-83c9-b2b5a19c039
REST API は仮想マシンを強制削除します。
235
REST API ガイド
付録B 列挙値の変換
B.1. 列挙値の変換
API は、Red Hat Enterprise Virtualization クエリー言語を使用して検索クエリーを実行します。クエリー
言語の詳細については、『Red Hat Enterprise Virtualization 管理ガイド』 の「Red Hat Enterprise
Virtualization での検索」のセクションに記載された完全な仕様を参照してください。
クエリー言語の使用時に、API の特定の列挙値には、異なる検索クエリーが必要なことに注意してくださ
い。以下の表には、これらの主要な列挙値の変換をまとめています。
表B .1 列挙値の変換
リソースタイプ
API 列挙タイプ
データセンター
d ata_center_st no t_o perati o n status
ates
al
ho st_states
no n_respo nsi v status
e
i nstal l _fai l e
d
prepari ng _fo r
_mai ntenance
no n_o perati o n
al
pend i ng _appro
val
vm_states
po weri ng _up
status
po weri ng _d o wn
mi g rati ng
mi g rati ng
no t_respo nd i n
g
wai t_fo r_l aun
ch
rebo o t_i n_pro
g ress
savi ng _state
resto ri ng _stat
e
i mag e_l o cked
ホスト
仮想マシン
236
API 列挙値
クエリー言語プロ
パティー
クエリー言語値
no to perati o na
l
no nrespo nsi ve
i nstal l fai l ed
prepari ng fo rm
ai ntenance
no no perati o na
l
pend i ng appro v
al
po weri ng up
po weri ng d o wn
mi g rati ng fro m
mi g rati ng to
no trespo nd i ng
wai tfo rl aunch
rebo o ti npro g r
ess
savi ng state
resto ri ng state
i mag el o cked
⁠付録C イベントコード
付録C イベントコード
C.1. イベントコード
以下の表には、全イベントコードをまとめています。
表C .1 イベントコード
コード
名前
重大度
0
1
2
12
UNASSIG NED
VD C _ST AR T
VD C _ST O P
VD S_FAILUR E
Info
Info
Info
Erro r
13
VD S_D ET EC T ED
Info
14
VD S_R EC O VER
Info
15
VD S_MAINT ENANC E
No rmal
16
VD S_AC T IVAT E
Info
17
VD S_MAINT ENANC E_FAIL
ED
Erro r
18
VD S_AC T IVAT E_FAILED
Erro r
19
VD S_R EC O VER _FAILED
Erro r
20
USER _VD S_ST AR T
Info
21
USER _VD S_ST O P
Info
22
IR S_FAILUR E
Erro r
23
VD S_LO W_D ISK_SP AC E
Warni ng
24
VD S_LO W_D ISK_SP AC E_E
RROR
Erro r
25
VD S_NO _SELINUX_ENFO R
C EMENT
Warni ng
メッセージ
Starti ng o Vi rt Eng i ne.
Sto ppi ng o Vi rt Eng i ne.
Ho st ${Vd sName} i s no n
respo nsi ve.
Status o f ho st ${Vd sName} was
set to ${Ho stStatus}.
Ho st ${Vd sName} i s
rebo o ti ng .
Ho st ${Vd sName} was swi tched
to Mai ntenance Mo d e.
Acti vati o n o f ho st
${Vd sName} i ni ti ated by
${UserName}.
Fai l ed to swi tch Ho st
${Vd sName} to Mai ntenance
mo d e.
Fai l ed to acti vate Ho st
${Vd sName}. (User:
${UserName}).
Ho st ${Vd sName} fai l ed to
reco ver.
Ho st ${Vd sName} was started
by ${UserName}.
Ho st ${Vd sName} was sto pped
by ${UserName}.
Fai l ed to access Sto rag e o n
Ho st ${Vd sName}.
Warni ng , Lo w d i sk space.
Ho st ${Vd sName} has l ess
than ${D i skSpace} MB o f free
space l eft o n: ${D i sks}.
C ri ti cal , Lo w d i sk space.
Ho st ${Vd sName} has l ess
than ${D i skSpace} MB o f free
space l eft o n: ${D i sks}. Lo w
d i sk space mi g ht cause an
i ssue upg rad i ng thi s ho st.
Ho st ${Vd sName} d o es no t
enfo rce SELi nux. C urrent
status: ${Mo d e}
237
REST API ガイド
コード
名前
重大度
メッセージ
26
IR S_D ISK_SP AC E_LO W
Warni ng
27
VD S_ST AT US_C HANG E_FA
ILED _D UE_T O _ST O P _SP M
_FAILUR E
VD S_P R O VISIO N
Warni ng
Info
31
32
USER _AD D _VM_T EMP LAT E
_SUC C ESS
USER _VD C _LO G O UT
USER _R UN_VM
33
USER _ST O P _VM
Info
34
USER _AD D _VM
Info
35
USER _UP D AT E_VM
Info
36
Erro r
37
USER _AD D _VM_T EMP LAT E
_FAILUR E
USER _AD D _VM_ST AR T ED
38
USER _C HANG E_D ISK_VM
Info
39
USER _P AUSE_VM
Info
40
USER _R ESUME_VM
Info
41
USER _VD S_R EST AR T
Info
42
USER _AD D _VD S
Info
43
USER _UP D AT E_VD S
Info
44
USER _R EMO VE_VD S
Info
45
USER _C R EAT E_SNAP SHO T
Info
Warni ng , Lo w d i sk space.
${Sto rag eD o mai nName} d o mai n
has ${D i skSpace} G B o f free
space.
Fai l ed to chang e status o f
ho st ${Vd sName} d ue to a
fai l ure to sto p the spm.
Instal l i ng O S o n Ho st
${Vd sName} usi ng Ho stg ro up
${Ho stG ro upName}.
T empl ate ${VmT empl ateName}
was created successful l y.
User ${UserName} l o g g ed o ut.
VM ${VmName} started o n Ho st
${Vd sName}
VM ${VmName} po wered o ff by
${UserName} (Ho st:
${Vd sName}) (R easo n:
${R easo n}).
VM ${VmName} was created by
${UserName}.
VM ${VmName} co nfi g urati o n
was upd ated by ${UserName}.
Fai l ed creati ng T empl ate
${VmT empl ateName}.
VM ${VmName} creati o n was
i ni ti ated by ${UserName}.
C D ${D i skName} was i nserted
to VM ${VmName} by
${UserName}.
VM ${VmName} was suspend ed
by ${UserName} (Ho st:
${Vd sName}).
VM ${VmName} was resumed by
${UserName} (Ho st:
${Vd sName}).
Ho st ${Vd sName} was restarted
by ${UserName}.
Ho st ${Vd sName} was ad d ed by
${UserName}.
Ho st ${Vd sName}
co nfi g urati o n was upd ated by
${UserName}.
Ho st ${Vd sName} was remo ved
by ${UserName}.
Snapsho t ' ${Snapsho tName}'
creati o n fo r VM ' ${VmName}'
was i ni ti ated by
${UserName}.
28
29
238
Warni ng
Info
Info
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
46
USER _T R Y _BAC K_T O _SNA
P SHO T
Info
47
USER _R EST O R E_FR O M_SN
AP SHO T
USER _AD D _VM_T EMP LAT E
Info
49
USER _UP D AT E_VM_T EMP L
AT E
Info
50
USER _R EMO VE_VM_T EMP L
AT E
Info
51
USER _AD D _VM_T EMP LAT E
_FINISHED _SUC C ESS
Info
52
USER _AD D _VM_T EMP LAT E
_FINISHED _FAILUR E
Erro r
53
Info
54
USER _AD D _VM_FINISHED
_SUC C ESS
USER _FAILED _R UN_VM
55
USER _FAILED _P AUSE_VM
Erro r
56
USER _FAILED _ST O P _VM
Erro r
57
USER _FAILED _AD D _VM
Erro r
58
USER _FAILED _UP D AT E_V
M
Erro r
Snapsho t-P revi ew
${Snapsho tName} fo r VM
${VmName} was i ni ti ated by
${UserName}.
VM ${VmName} resto red fro m
Snapsho t by ${UserName}.
C reati o n o f T empl ate
${VmT empl ateName} fro m VM
${VmName} was i ni ti ated by
${UserName}.
T empl ate ${VmT empl ateName}
co nfi g urati o n was upd ated by
${UserName}.
R emo val o f T empl ate
${VmT empl ateName} was
i ni ti ated by ${UserName}.
C reati o n o f T empl ate
${VmT empl ateName} fro m VM
${VmName} has been
co mpl eted .
Fai l ed to co mpl ete creati o n
o f T empl ate
${VmT empl ateName} fro m VM
${VmName}.
VM ${VmName} creati o n has
been co mpl eted .
Fai l ed to run VM ${VmName}
(User: ${UserName}).
Fai l ed to suspend VM
${VmName} (Ho st: ${Vd sName},
User: ${UserName}).
Fai l ed to po wer o ff VM
${VmName} (Ho st: ${Vd sName},
User: ${UserName}).
Fai l ed to create VM
${VmName} (User:
${UserName}).
Fai l ed to upd ate VM
${VmName} (User:
${UserName}).
59
Erro r
61
USER _FAILED _R EMO VE_V
M
USER _AD D _VM_FINISHED
_FAILUR E
VM_D O WN
62
VM_MIG R AT IO N_ST AR T
Info
48
60
Info
Erro r
Erro r
Info
Fai l ed to co mpl ete VM
${VmName} creati o n.
VM ${VmName} i s d o wn.
${Exi tMessag e}
Mi g rati o n started (VM:
${VmName}, So urce:
${Vd sName}, D esti nati o n:
${D esti nati o nVd sName}, User:
${UserName}).
239
REST API ガイド
コード
名前
重大度
メッセージ
63
VM_MIG R AT IO N_D O NE
Info
64
VM_MIG R AT IO N_ABO R T
Erro r
65
VM_MIG R AT IO N_FAILED
Erro r
66
VM_FAILUR E
Erro r
67
VM_MIG R AT IO N_ST AR T _S
Y ST EM_INIT IAT ED
Info
68
USER _C R EAT E_SNAP SHO T
_FINISHED _SUC C ESS
Info
69
USER _C R EAT E_SNAP SHO T
_FINISHED _FAILUR E
Erro r
70
USER _R UN_VM_AS_ST AT E Erro r
LESS_FINISHED _FAILUR E
USER _T R Y _BAC K_T O _SNA Info
P SHO T _FINISH_SUC C ESS
Mi g rati o n co mpl eted (VM:
${VmName}, So urce:
${Vd sName}, D esti nati o n:
${D esti nati o nVd sName},
D urati o n: ${D urati o n},
T o tal : ${T o tal D urati o n},
Actual d o wnti me:
${Actual D o wnti me})
Mi g rati o n fai l ed :
${Mi g rati o nErro r} (VM:
${VmName}, So urce:
${Vd sName}, D esti nati o n:
${D esti nati o nVd sName}).
Mi g rati o n
fai l ed ${D ueT o Mi g rati o nErro r}
(VM: ${VmName}, So urce:
${Vd sName}).
VM ${VmName} canno t be fo und
o n Ho st ${Vd sName}.
Mi g rati o n i ni ti ated by
system (VM: ${VmName},
So urce: ${Vd sName},
D esti nati o n:
${D esti nati o nVd sName}).
Snapsho t ' ${Snapsho tName}'
creati o n fo r VM ' ${VmName}'
has been co mpl eted .
Fai l ed to co mpl ete snapsho t
' ${Snapsho tName}' creati o n
fo r VM ' ${VmName}' .
Fai l ed to co mpl ete starti ng
o f VM ${VmName}.
Snapsho t-P revi ew
${Snapsho tName} fo r VM
${VmName} has been
co mpl eted .
Fl o ppy ${D i skName} was
i nserted i n VM ${VmName} by
${UserName}
VM shutd o wn i ni ti ated by
${UserName} o n VM ${VmName}
(Ho st: ${Vd sName}) (R easo n:
${R easo n}).
Fai l ed to i ni ti ate shutd o wn
o n VM ${VmName} (Ho st:
${Vd sName}, User:
${UserName}).
Fai l ed to chang e fl o ppy
${D i skName} (User:
${UserName}).
71
72
USER _C HANG E_FLO P P Y _V
M
Info
73
USER _INIT IAT ED _SHUT D
O WN_VM
Info
74
USER _FAILED _SHUT D O WN
_VM
Erro r
75
USER _FAILED _C HANG E_F
LO P P Y _VM
Erro r
24 0
⁠付録C イベントコード
コード
名前
重大度
メッセージ
76
USER _ST O P P ED _VM_INST
EAD _O F_SHUT D O WN
Info
77
USER _FAILED _ST O P P ING
_VM_INST EAD _O F_SHUT D
O WN
USER _AD D _D ISK_T O _VM
Erro r
79
USER _FAILED _AD D _D ISK
_T O _VM
Erro r
80
USER _R EMO VE_D ISK_FR O
M_VM
USER _FAILED _R EMO VE_D
ISK_FR O M_VM
Info
82
USER _MO VED _VM
Info
83
USER _FAILED _MO VE_VM
Erro r
84
USER _MO VED _T EMP LAT E
Info
85
USER _FAILED _MO VE_T EM
P LAT E
Erro r
86
USER _C O P IED _T EMP LAT E
Info
87
USER _FAILED _C O P Y _T EM
P LAT E
Erro r
88
USER _UP D AT E_VM_D ISK
Info
89
USER _FAILED _UP D AT E_V
M_D ISK
Erro r
VM ${VmName} was po wered o ff
ung raceful l y by ${UserName}
(Ho st: ${Vd sName}) (R easo n:
${R easo n}).
Fai l ed to po wer o ff VM
${VmName} (Ho st: ${Vd sName},
User: ${UserName}).
Ad d -D i sk o perati o n o f
${D i skAl i as} was i ni ti ated
o n VM ${VmName} by
${UserName}.
Ad d -D i sk o perati o n fai l ed
o n VM ${VmName} (User:
${UserName}).
D i sk was remo ved fro m VM
${VmName} by ${UserName}.
Fai l ed to remo ve D i sk fro m
VM ${VmName} (User:
${UserName}).
VM ${VmName} mo vi ng to
D o mai n ${Sto rag eD o mai nName}
was i ni ti ated by
${UserName}.
Fai l ed to i ni ti ate mo vi ng
o f VM ${VmName} to D o mai n
${Sto rag eD o mai nName} (User:
${UserName}).
T empl ate ${VmT empl ateName}
mo vi ng to D o mai n
${Sto rag eD o mai nName} was
i ni ti ated by ${UserName}.
Fai l ed to i ni ti ate mo vi ng
T empl ate ${VmT empl ateName}
to D o mai n
${Sto rag eD o mai nName} (User:
${UserName}).
T empl ate ${VmT empl ateName}
co py to D o mai n
${Sto rag eD o mai nName} was
i ni ti ated by ${UserName}.
Fai l ed to i ni ti ate co py o f
T empl ate ${VmT empl ateName}
to D o mai n
${Sto rag eD o mai nName} (User:
${UserName}).
VM ${VmName} ${D i skAl i as}
d i sk was upd ated by
${UserName}.
Fai l ed to upd ate VM
${VmName} d i sk ${D i skAl i as}
(User: ${UserName}).
78
81
Info
Erro r
24 1
REST API ガイド
コード
名前
重大度
メッセージ
90
VD S_FAILED _T O _G ET _HO
ST _HAR D WAR E_INFO
Warni ng
91
USER _MO VED _VM_FINISH
ED _SUC C ESS
Info
92
USER _MO VED _VM_FINISH
ED _FAILUR E
Erro r
93
USER _MO VED _T EMP LAT E_
FINISHED _SUC C ESS
Info
94
USER _MO VED _T EMP LAT E_
FINISHED _FAILUR E
Erro r
95
USER _C O P IED _T EMP LAT E
_FINISHED _SUC C ESS
Info
96
USER _C O P IED _T EMP LAT E
_FINISHED _FAILUR E
Erro r
97
USER _AD D _D ISK_T O _VM_
FINISHED _SUC C ESS
Info
98
USER _AD D _D ISK_T O _VM_
FINISHED _FAILUR E
USER _T R Y _BAC K_T O _SNA
P SHO T _FINISH_FAILUR E
Erro r
USER _R EST O R E_FR O M_SN
AP SHO T _FINISH_SUC C ES
S
USER _R EST O R E_FR O M_SN
AP SHO T _FINISH_FAILUR
E
USER _FAILED _C HANG E_D
ISK_VM
Info
C o ul d no t g et hard ware
i nfo rmati o n fo r ho st
${Vd sName}
Mo vi ng VM ${VmName} to
D o mai n ${Sto rag eD o mai nName}
has been co mpl eted .
Fai l ed to co mpl ete mo vi ng
o f VM ${VmName} to D o mai n
${Sto rag eD o mai nName}.
T empl ate ${VmT empl ateName}
mo vi ng to D o mai n
${Sto rag eD o mai nName} has
been co mpl eted .
Fai l ed to co mpl ete mo vi ng
o f T empl ate
${VmT empl ateName} to D o mai n
${Sto rag eD o mai nName}.
T empl ate ${VmT empl ateName}
co py to D o mai n
${Sto rag eD o mai nName} has
been co mpl eted .
Fai l ed to co mpl ete co py o f
T empl ate ${VmT empl ateName}
to D o mai n
${Sto rag eD o mai nName}.
T he d i sk ${D i skAl i as} was
successful l y ad d ed to VM
${VmName}.
Ad d -D i sk o perati o n fai l ed
to co mpl ete o n VM ${VmName}.
Fai l ed to co mpl ete Snapsho tP revi ew ${Snapsho tName} fo r
VM ${VmName}.
VM ${VmName} resto ri ng fro m
Snapsho t has been co mpl eted .
10 3
USER _FAILED _R ESUME_V
M
Erro r
10 4
USER _FAILED _AD D _VD S
Erro r
10 5
USER _FAILED _UP D AT E_V
DS
Erro r
99
10 0
10 1
10 2
24 2
Erro r
Erro r
Erro r
Fai l ed to co mpl ete resto ri ng
fro m Snapsho t o f VM
${VmName}.
Fai l ed to chang e d i sk i n VM
${VmName} (Ho st: ${Vd sName},
User: ${UserName}).
Fai l ed to resume VM
${VmName} (Ho st: ${Vd sName},
User: ${UserName}).
Fai l ed to ad d Ho st
${Vd sName} (User:
${UserName}).
Fai l ed to upd ate Ho st
${Vd sName} (User:
${UserName}).
⁠付録C イベントコード
コード
名前
重大度
メッセージ
10 6
USER _FAILED _R EMO VE_V
DS
Erro r
10 7
USER _FAILED _VD S_R EST
AR T
Erro r
10 8
USER _FAILED _AD D _VM_T
EMP LAT E
Erro r
10 9
USER _FAILED _UP D AT E_V
M_T EMP LAT E
Erro r
110
USER _FAILED _R EMO VE_V
M_T EMP LAT E
Erro r
111
USER _ST O P _SUSP END ED _
VM
Info
112
USER _ST O P _SUSP END ED _
VM_FAILED
Erro r
113
USER _R EMO VE_VM_FINIS
HED
USER _VD C _LO G IN_FAILE
D
USER _FAILED _T R Y _BAC K
_T O _SNAP SHO T
Info
116
USER _FAILED _R EST O R E_
FR O M_SNAP SHO T
Erro r
117
USER _FAILED _C R EAT E_S
NAP SHO T
Erro r
118
USER _FAILED _VD S_ST AR
T
Erro r
119
VM_D O WN_ER R O R
Erro r
120
VM_MIG R AT IO N_T O _SER V
ER _FAILED
Erro r
121
SY ST EM_VD S_R EST AR T
Info
Fai l ed to remo ve Ho st
${Vd sName} (User:
${UserName}).
Fai l ed to restart Ho st
${Vd sName}, (User:
${UserName}).
Fai l ed to i ni ti ate creati o n
o f T empl ate
${VmT empl ateName} fro m VM
${VmName} (User:
${UserName}).
Fai l ed to upd ate T empl ate
${VmT empl ateName} (User:
${UserName}).
Fai l ed to i ni ti ate remo val
o f T empl ate
${VmT empl ateName} (User:
${UserName}).
Suspend ed VM ${VmName} has
had i ts save state cl eared
by ${UserName} (R easo n:
${R easo n}).
Fai l ed to po wer o ff
suspend ed VM ${VmName}
(User: ${UserName}).
VM ${VmName} was
successful l y remo ved .
User ${UserName} fai l ed to
l o g i n.
Fai l ed to previ ew Snapsho t
${Snapsho tName} fo r VM
${VmName} (User:
${UserName}).
Fai l ed to resto re VM
${VmName} fro m Snapsho t
(User: ${UserName}).
Fai l ed to create Snapsho t
${Snapsho tName} fo r VM
${VmName} (User:
${UserName}).
Fai l ed to start Ho st
${Vd sName}, (User:
${UserName}).
VM ${VmName} i s d o wn wi th
erro r. ${Exi tMessag e}.
Mi g rati o n
fai l ed ${D ueT o Mi g rati o nErro r}
(VM: ${VmName}, So urce:
${Vd sName}, D esti nati o n:
${D esti nati o nVd sName}).
Ho st ${Vd sName} was restarted
by the eng i ne.
114
115
Erro r
Erro r
24 3
REST API ガイド
コード
名前
重大度
メッセージ
122
SY ST EM_FAILED _VD S_R E
ST AR T
Erro r
123
Warni ng
124
VD S_SLO W_ST O R AG E_R ES
P O NSE_T IME
VM_IMP O R T
125
VM_IMP O R T _FAILED
Erro r
126
VM_NO T _R ESP O ND ING
Warni ng
127
VD S_R UN_IN_NO _KVM_MO
DE
Erro r
128
VM_MIG R AT IO N_T R Y ING _
R ER UN
Warni ng
129
130
VM_C LEAR ED
USER _SUSP END _VM_FINI
SH_FAILUR E_WILL_T R Y _
AG AIN
USER _EXP O R T _VM
Info
Erro r
132
USER _EXP O R T _VM_FAILE
D
Erro r
133
USER _EXP O R T _T EMP LAT E
Info
134
USER _EXP O R T _T EMP LAT E
_FAILED
Erro r
135
T EMP LAT E_IMP O R T
Info
136
T EMP LAT E_IMP O R T _FAIL
ED
Erro r
137
USER _FAILED _VD S_ST O P
Erro r
138
VM_P AUSED _ENO SP C
Erro r
139
VM_P AUSED _ER R O R
Erro r
A restart i ni ti ated by the
eng i ne to Ho st ${Vd sName}
has fai l ed .
Sl o w sto rag e respo nse ti me
o n Ho st ${Vd sName}.
Started VM i mpo rt o f
${Impo rted VmName} (User:
${UserName})
Fai l ed to i mpo rt VM
${Impo rted VmName} (User:
${UserName})
VM ${VmName} i s no t
respo nd i ng .
Ho st ${Vd sName} runni ng
wi tho ut vi rtual i zati o n
hard ware accel erati o n
Fai l ed to mi g rate VM
${VmName} to Ho st
${D esti nati o nVd sName}${D ueT o
Mi g rati o nErro r}. T ryi ng to
mi g rate to ano ther Ho st.
Unused
Fai l ed to co mpl ete
suspend i ng o f VM ${VmName},
wi l l try ag ai n.
VM ${VmName} expo rted to
${Expo rtP ath} by ${UserName}
Fai l ed to expo rt VM
${VmName} to ${Expo rtP ath}
(User: ${UserName})
T empl ate ${VmT empl ateName}
expo rted to ${Expo rtP ath} by
${UserName}
Fai l ed to expo rt T empl ate
${VmT empl ateName} to
${Expo rtP ath} (User:
${UserName})
Started T empl ate i mpo rt o f
${Impo rted VmT empl ateName}
(User: ${UserName})
Fai l ed to i mpo rt T empl ate
${Impo rted VmT empl ateName}
(User: ${UserName})
Fai l ed to sto p Ho st
${Vd sName}, (User:
${UserName}).
VM ${VmName} has been paused
d ue to no Sto rag e space
erro r.
VM ${VmName} has been paused
d ue to unkno wn sto rag e
erro r.
131
24 4
Info
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
14 0
VM_MIG R AT IO N_FAILED _
D UR ING _MO VE_T O _MAINT
ENANC E
Erro r
14 1
VD S_VER SIO N_NO T _SUP P
O R T ED _FO R _C LUST ER
Erro r
14 2
Warni ng
14 4
VM_SET _T O _UNKNO WN_ST
AT US
VM_WAS_SET _D O WN_D UE_
T O _HO ST _R EBO O T _O R _M
ANUAL_FENC E
VM_IMP O R T _INFO
14 5
VM_P AUSED _EIO
Erro r
14 6
VM_P AUSED _EP ER M
Erro r
14 7
VM_P O WER _D O WN_FAILED
Warni ng
14 8
VM_MEMO R Y _UND ER _G UAR
ANT EED _VALUE
Erro r
14 9
USER _AD D
Info
150
USER _INIT IAT ED _R UN_V
M
USER _INIT IAT ED _R UN_V
M_FAILED
USER _R UN_VM_O N_NO N_D
EFAULT _VD S
Info
Mi g rati o n
fai l ed ${D ueT o Mi g rati o nErro r}
whi l e Ho st i s i n ' prepari ng
fo r mai ntenance' state. \n
C o nsi d er manual
i nterventi o n\:
sto ppi ng /mi g rati ng Vms as
Ho st' s state wi l l no t\n turn
to mai ntenance whi l e VMs are
sti l l runni ng o n i t. (VM:
${VmName}, So urce:
${Vd sName}, D esti nati o n:
${D esti nati o nVd sName}).
Ho st ${Vd sName} i s i nstal l ed
wi th VD SM versi o n
(${Vd sSuppo rted Versi o ns})
and canno t jo i n cl uster
${Vd sG ro upName} whi ch i s
co mpati bl e wi th VD SM
versi o ns
${C o mpati bi l i tyVersi o n}.
VM ${VmName} was set to the
Unkno wn status.
Vm ${VmName} was shut d o wn
d ue to ${Vd sName} ho st
rebo o t o r manual fence
Val ue o f fi el d ${Fi el d Name}
o f i mpo rted VM ${VmName} i s
${Fi el d Val ue}. T he fi el d i s
reset to the d efaul t val ue
VM ${VmName} has been paused
d ue to sto rag e I/O pro bl em.
VM ${VmName} has been paused
d ue to sto rag e permi ssi o ns
pro bl em.
Shutd o wn o f VM ${VmName}
fai l ed .
VM ${VmName} o n ho st
${Vd sName} was g uaranteed
${MemG uaranteed } MB but
currentl y has ${MemActual } MB
User ' ${NewUserName}' was
ad d ed successful l y to the
system.
Starti ng VM ${VmName} was
i ni ti ated by ${UserName}.
Fai l ed to run VM ${VmName}
o n Ho st ${Vd sName}.
G uest ${VmName} started o n
Ho st ${Vd sName}. (D efaul t
Ho st parameter was i g no red assi g ned Ho st was no t
avai l abl e).
14 3
151
152
Info
Info
Warni ng
Warni ng
24 5
REST API ガイド
コード
名前
重大度
メッセージ
153
USER _ST AR T ED _VM
Info
154
VD S_C LUST ER _VER SIO N_
NO T _SUP P O R T ED
Erro r
155
VD S_AR C HIT EC T UR E_NO T
_SUP P O R T ED _FO R _C LUS
T ER
Erro r
156
C P U_T Y P E_UNSUP P O R T E
D _IN_T HIS_C LUST ER _VE
R SIO N
Erro r
157
USER _R EBO O T _VM
Info
158
USER _FAILED _R EBO O T _V
M
Erro r
159
USER _FO R C E_SELEC T ED _
SP M
USER _AC C O UNT _D ISABLE
D _O R _LO C KED
Info
16 1
VM_C ANC EL_MIG R AT IO N
Info
16 2
Erro r
16 3
VM_C ANC EL_MIG R AT IO N_
FAILED
VM_ST AT US_R EST O R ED
16 4
VM_SET _T IC KET
Info
16 5
VM_SET _T IC KET _FAILED
Erro r
16 6
VM_MIG R AT IO N_NO _VD S_
T O _MIG R AT E_T O
VM_C O NSO LE_C O NNEC T ED
Warni ng
VM ${VmName} was started by
${UserName} (Ho st:
${Vd sName}).
Ho st ${Vd sName} i s
co mpati bl e wi th versi o ns
(${Vd sSuppo rted Versi o ns})
and canno t jo i n C l uster
${Vd sG ro upName} whi ch i s set
to versi o n
${C o mpati bi l i tyVersi o n}.
Ho st ${Vd sName} has
archi tecture
${Vd sArchi tecture} and canno t
jo i n C l uster ${Vd sG ro upName}
whi ch has archi tecture
${Vd sG ro upArchi tecture}.
Ho st ${Vd sName} mo ved to
No n-O perati o nal state as
ho st C P U type i s no t
suppo rted i n thi s cl uster
co mpati bi l i ty versi o n o r i s
no t suppo rted at al l
User ${UserName} i ni ti ated
rebo o t o f VM ${VmName}.
Fai l ed to rebo o t VM
${VmName} (User:
${UserName}).
Ho st ${Vd sName} was fo rce
sel ected by ${UserName}
User ${UserName} canno t
l o g i n, as i t g o t d i sabl ed
o r l o cked . P l ease co ntact
the system ad mi ni strato r.
Mi g rati o n cancel l ed (VM:
${VmName}, So urce:
${Vd sName}, User:
${UserName}).
Fai l ed to cancel mi g rati o n
fo r VM: ${VmName}
VM ${VmName} status was
resto red to ${VmStatus}.
User ${UserName} i ni ti ated
co nso l e sessi o n fo r VM
${VmName}
User ${UserName} fai l ed to
i ni ti ate a co nso l e sessi o n
fo r VM ${VmName}
No avai l abl e ho st was fo und
to mi g rate VM ${VmName} to .
User ${UserName} i s co nnected
to VM ${VmName}.
16 0
16 7
24 6
Erro r
Info
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
16 8
VM_C O NSO LE_D ISC O NNEC
T ED
Info
16 9
VM_FAILED _T O _P R EST AR
T _IN_P O O L
Warni ng
170
USER _C R EAT E_LIVE_SNA
P SHO T _FINISHED _FAILU
RE
Warni ng
171
USER _R UN_VM_AS_ST AT E
LESS_WIT H_D ISKS_NO T _
ALLO WING _SNAP SHO T
Warni ng
172
USER _R EMO VE_VM_FINIS
HED _WIT H_ILLEG AL_D IS
KS
Warni ng
173
USER _C R EAT E_LIVE_SNA
P SHO T _NO _MEMO R Y _FAIL
UR E
Erro r
174
VM_IMP O R T _FR O M_C O NFI
G UR AT IO N_EXEC UT ED _SU
C C ESSFULLY
VM_IMP O R T _FR O M_C O NFI
G UR AT IO N_AT T AC H_D ISK
S_FAILED
Info
176
VM_BALLO O N_D R IVER _ER
ROR
Erro r
177
VM_BALLO O N_D R IVER _UN
C O NT R O LLED
Erro r
178
VM_MEMO R Y _NO T _IN_R EC
O MMEND ED _R ANG E
Warni ng
User ${UserName} g o t
d i sco nnected fro m VM
${VmName}.
C anno t pre-start VM i n po o l
' ${VmP o o l Name}' . T he system
wi l l co nti nue tryi ng .
Fai l ed to create l i ve
snapsho t ' ${Snapsho tName}'
fo r VM ' ${VmName}' . VM
restart i s reco mmend ed . No te
that usi ng the created
snapsho t mi g ht cause d ata
i nco nsi stency.
VM ${VmName} was run as
statel ess wi th o ne o r mo re
o f d i sks that d o no t al l o w
snapsho ts (User: ${UserName}).
VM ${VmName} has been
remo ved , but the fo l l o wi ng
d i sks co ul d no t be remo ved :
${D i sksNames}. T hese d i sks
wi l l appear i n the mai n
d i sks tab i n i l l eg al state,
pl ease remo ve manual l y when
po ssi bl e.
Fai l ed to save memo ry as
part o f Snapsho t
${Snapsho tName} fo r VM
${VmName} (User:
${UserName}).
VM ${VmName} has been
successful l y i mpo rted fro m
the g i ven co nfi g urati o n.
VM ${VmName} has been
i mpo rted fro m the g i ven
co nfi g urati o n but the
fo l l o wi ng d i sk(s) fai l ed to
attach: ${D i skAl i ases}.
T he Bal l o o n d ri ver o n VM
${VmName} o n ho st ${Vd sName}
i s req uested but
unavai l abl e.
T he Bal l o o n d evi ce o n VM
${VmName} o n ho st ${Vd sName}
i s i nfl ated but the d evi ce
canno t be co ntro l l ed (g uest
ag ent i s d o wn).
VM ${VmName} was co nfi g ured
wi th ${VmMemInMb}mb o f
memo ry whi l e the reco mmend ed
val ue rang e i s
${VmMi nMemInMb}mb ${VmMaxMemInMb}mb
175
Warni ng
24 7
REST API ガイド
コード
名前
重大度
メッセージ
179
USER _INIT IAT ED _R UN_V
M_AND _P AUSE
Info
180
T EMP LAT E_IMP O R T _FR O M Info
_C O NFIG UR AT IO N_SUC C E
SS
181
T EMP LAT E_IMP O R T _FR O M Erro r
_C O NFIG UR AT IO N_FAILE
D
USER _FAILED _AT T AC H_U Erro r
SER _T O _VM
Starti ng i n paused mo d e VM
${VmName} was i ni ti ated by
${UserName}.
T empl ate ${VmT empl ateName}
has been successful l y
i mpo rted fro m the g i ven
co nfi g urati o n.
Fai l ed to i mpo rt T empl ate
${VmT empl ateName} fro m the
g i ven co nfi g urati o n.
Fai l ed to attach User
${Ad UserName} to VM ${VmName}
(User: ${UserName}).
T ag ${T ag Name} was attached
to T empl ates(s)
${T empl atesNames} by
${UserName}.
Fai l ed to attach T ag
${T ag Name} to T empl ates(s)
${T empl atesNames} (User:
${UserName}).
T ag ${T ag Name} was d etached
fro m T empl ate(s)
${T empl atesNames} by
${UserName}.
Fai l ed to d etach T ag
${T ag Name} fro m T EMP LAT E(s)
${T empl atesNames} (User:
${UserName}).
Fai l ed to co nnect Ho st
${Vd sName} to D ata C enter,
d ue to co nnecti vi ty erro rs
wi th the Sto rag e. Ho st
${Vd sName} wi l l remai n i n Up
state (but i nacti ve), as i t
i s the l ast Ho st i n the D ata
C enter, to enabl e manual
i nterventi o n by the
Ad mi ni strato r.
Fai l ed to co nnect Ho st
${Vd sName} to the Sto rag e
D o mai ns
${fai l ed Sto rag eD o mai ns}.
Ho st ${Vd sName} repo rts abo ut
o ne o f the Acti ve Sto rag e
D o mai ns as P ro bl emati c.
Fai l ed to upd ate
VMs/T empl ates O VF d ata fo r
Sto rag e D o mai n
${Sto rag eD o mai nName} i n D ata
C enter ${Sto rag eP o o l Name}.
182
183
USER _AT T AC H_T AG _T O _T
EMP LAT E
Info
184
USER _AT T AC H_T AG _T O _T
EMP LAT E_FAILED
Erro r
185
USER _D ET AC H_T EMP LAT E
_FR O M_T AG
Info
186
USER _D ET AC H_T EMP LAT E
_FR O M_T AG _FAILED
Erro r
187
VD S_ST O R AG E_C O NNEC T I Erro r
O N_FAILED _BUT _LAST _V
DS
188
VD S_ST O R AG ES_C O NNEC T
IO N_FAILED
Erro r
189
VD S_ST O R AG E_VD S_ST AT
S_FAILED
Erro r
19 0
UP D AT E_O VF_FO R _ST O R A Warni ng
G E_D O MAIN_FAILED
24 8
⁠付録C イベントコード
コード
名前
重大度
メッセージ
19 1
C R EAT E_O VF_ST O R E_FO R
_ST O R AG E_D O MAIN_FAIL
ED
Warni ng
19 2
C R EAT E_O VF_ST O R E_FO R
_ST O R AG E_D O MAIN_INIT
IAT E_FAILED
Warni ng
19 3
D ELET E_O VF_ST O R E_FO R
_ST O R AG E_D O MAIN_FAIL
ED
Warni ng
19 4
VM_C ANC EL_C O NVER SIO N
Info
19 5
VM_C ANC EL_C O NVER SIO N
_FAILED
VM_R EC O VER ED _FR O M_P A
USE_ER R O R
IMP O R T EXP O R T _G ET _VM
S_INFO _FAILED
Erro r
20 1
IR S_D ISK_SP AC E_LO W_E
RROR
Erro r
20 2
Erro r
20 4
IMP O R T EXP O R T _G ET _EX
T ER NAL_VMS_INFO _FAIL
ED
IR S_HO ST ED _O N_VD S
20 5
P R O VID ER _AD D ED
Info
20 6
P R O VID ER _AD D IT IO N_FA Erro r
ILED
20 7
P R O VID ER _UP D AT ED
Fai l ed to create O VF sto re
d i sk fo r Sto rag e D o mai n
${Sto rag eD o mai nName}. \n T he
D i sk wi th the i d ${D i skId }
mi g ht be remo ved manual l y
fo r auto mati c attempt to
create new o ne. \n O VF
upd ates wo n' t be attempted
o n the created d i sk.
Fai l ed to create O VF sto re
d i sk fo r Sto rag e D o mai n
${Sto rag eD o mai nName}. \n O VF
d ata wo n' t be upd ated
meanwhi l e fo r that d o mai n.
Fai l ed to d el ete the O VF
sto re d i sk fo r Sto rag e
D o mai n
${Sto rag eD o mai nName}. \n In
o rd er to d etach the d o mai n
pl ease remo ve i t manual l y o r
try to d etach the d o mai n
ag ai n fo r ano ther attempt.
C o nversi o n cancel l ed (VM:
${VmName}, So urce:
${Vd sName}, User:
${UserName}).
Fai l ed to cancel co nversi o n
fo r VM: ${VmName}
VM ${VmName} has reco vered
fro m paused back to up.
Fai l ed to retri eve
VM/T empl ates i nfo rmati o n
fro m expo rt d o mai n
${Sto rag eD o mai nName}
C ri ti cal , Lo w d i sk space.
${Sto rag eD o mai nName} d o mai n
has ${D i skSpace} G B o f free
space.
Fai l ed to retri eve VMs
i nfo rmati o n fro m external
server ${UR L}
Sto rag e P o o l Manag er runs o n
Ho st ${Vd sName} (Ad d ress:
${ServerIp}).
P ro vi d er ${P ro vi d erName} was
ad d ed . (User: ${UserName})
Fai l ed to ad d pro vi d er
${P ro vi d erName}. (User:
${UserName})
P ro vi d er ${P ro vi d erName} was
upd ated . (User: ${UserName})
19 6
20 0
No rmal
Erro r
Info
Info
24 9
REST API ガイド
コード
名前
重大度
メッセージ
20 8
P R O VID ER _UP D AT E_FAIL
ED
Erro r
20 9
P R O VID ER _R EMO VED
Info
210
P R O VID ER _R EMO VAL_FAI
LED
Erro r
213
P R O VID ER _C ER T IFIC AT
E_IMP O R T ED
Info
214
P R O VID ER _C ER T IFIC AT
E_IMP O R T _FAILED
Erro r
250
USER _UP D AT E_VM_C LUST
ER _D EFAULT _HO ST _C LEA
R ED
USER _R EMO VE_VM_T EMP L
AT E_FINISHED
Info
252
SY ST EM_FAILED _UP D AT E
_VM
Erro r
253
SY ST EM_UP D AT E_VM
Info
254
VM_ALR EAD Y _IN_R EQ UES
T ED _ST AT US
Info
30 2
USER _AD D _VM_P O O L_WIT
H_VMS
Info
30 3
USER _AD D _VM_P O O L_WIT
H_VMS_FAILED
Erro r
30 4
USER _R EMO VE_VM_P O O L
Info
30 5
USER _R EMO VE_VM_P O O L_
FAILED
Erro r
30 6
USER _AD D _VM_T O _P O O L
Info
30 7
USER _AD D _VM_T O _P O O L_
FAILED
Erro r
30 8
USER _R EMO VE_VM_FR O M_
POOL
Info
Fai l ed to upd ate pro vi d er
${P ro vi d erName}. (User:
${UserName})
P ro vi d er ${P ro vi d erName} was
remo ved . (User: ${UserName})
Fai l ed to remo ve pro vi d er
${P ro vi d erName}. (User:
${UserName})
C erti fi cate fo r pro vi d er
${P ro vi d erName} was
i mpo rted . (User:
${UserName})
Fai l ed i mpo rti ng C erti fi cate
fo r pro vi d er
${P ro vi d erName}. (User:
${UserName})
${VmName} cl uster was upd ated
by ${UserName}, D efaul t ho st
was reset to auto assi g n.
R emo val o f T empl ate
${VmT empl ateName} has been
co mpl eted .
Fai l ed to Upd ate VM
${VmName} that was i ni ti ated
by system.
VM ${VmName} co nfi g urati o n
was upd ated by system.
VM ${VmName} i s al read y
${VmStatus}, ${Acti o n} was
ski pped . User: ${UserName}.
VM P o o l ${VmP o o l Name}
(co ntai ni ng ${VmsC o unt} VMs)
was created by ${UserName}.
Fai l ed to create VM P o o l
${VmP o o l Name} (User:
${UserName}).
VM P o o l ${VmP o o l Name} was
remo ved by ${UserName}.
Fai l ed to remo ve VM P o o l
${VmP o o l Name} (User:
${UserName}).
VM ${VmName} was ad d ed to VM
P o o l ${VmP o o l Name} by
${UserName}.
Fai l ed to ad d VM ${VmName}
to VM P o o l ${VmP o o l Name}
(User: ${UserName}).
VM ${VmName} was remo ved
fro m VM P o o l ${VmP o o l Name}
by ${UserName}.
251
250
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
30 9
USER _R EMO VE_VM_FR O M_
P O O L_FAILED
Erro r
310
USER _AT T AC H_USER _T O _
POOL
Info
311
USER _AT T AC H_USER _T O _
P O O L_FAILED
Erro r
312
USER _D ET AC H_USER _FR O
M_P O O L
Info
313
USER _D ET AC H_USER _FR O
M_P O O L_FAILED
Erro r
314
USER _UP D AT E_VM_P O O L
Info
315
USER _UP D AT E_VM_P O O L_
FAILED
Erro r
316
USER _AT T AC H_USER _T O _
VM_FR O M_P O O L
Info
317
USER _AT T AC H_USER _T O _
VM_FR O M_P O O L_FAILED
Erro r
318
USER _AT T AC H_USER _T O _
VM_FR O M_P O O L_FINISHE
D _SUC C ESS
Info
319
USER _AT T AC H_USER _T O _
VM_FR O M_P O O L_FINISHE
D _FAILUR E
USER _AD D _VM_P O O L_WIT
H_VMS_AD D _VD S_FAILED
Erro r
325
USER _R EMO VE_AD USER
Info
326
USER _FAILED _R EMO VE_A
D USER
Erro r
327
USER _FAILED _AD D _AD US
ER
Warni ng
Fai l ed to remo ve VM
${VmName} fro m VM P o o l
${VmP o o l Name} (User:
${UserName}).
User ${Ad UserName} was
attached to VM P o o l
${VmP o o l Name} by
${UserName}.
Fai l ed to attach User
${Ad UserName} to VM P o o l
${VmP o o l Name} (User:
${UserName}).
User ${Ad UserName} was
d etached fro m VM P o o l
${VmP o o l Name} by
${UserName}.
Fai l ed to d etach User
${Ad UserName} fro m VM P o o l
${VmP o o l Name} (User:
${UserName}).
VM P o o l ${VmP o o l Name}
co nfi g urati o n was upd ated by
${UserName}.
Fai l ed to upd ate VM P o o l
${VmP o o l Name} co nfi g urati o n
(User: ${UserName}).
Attachi ng User ${Ad UserName}
to VM ${VmName} i n VM P o o l
${VmP o o l Name} was i ni ti ated
by ${UserName}.
Fai l ed to attach User
${Ad UserName} to VM fro m VM
P o o l ${VmP o o l Name} (User:
${UserName}).
User ${Ad UserName}
successful l y attached to VM
${VmName} i n VM P o o l
${VmP o o l Name}.
Fai l ed to attach user
${Ad UserName} to VM ${VmName}
i n VM P o o l ${VmP o o l Name}.
P o o l ${VmP o o l Name} C reated ,
but so me Vms fai l ed to
create (User: ${UserName}).
User ${Ad UserName} was
remo ved by ${UserName}.
Fai l ed to remo ve User
${Ad UserName} (User:
${UserName}).
Fai l ed to ad d User
' ${NewUserName}' to the
system.
320
Erro r
251
REST API ガイド
コード
名前
重大度
メッセージ
34 2
USER _R EMO VE_SNAP SHO T
Info
34 3
USER _FAILED _R EMO VE_S
NAP SHO T
Erro r
34 4
USER _UP D AT E_VM_P O O L_
WIT H_VMS
Info
34 5
USER _UP D AT E_VM_P O O L_
WIT H_VMS_FAILED
Erro r
34 6
USER _P ASSWO R D _C HANG E
D
USER _P ASSWO R D _C HANG E
_FAILED
USER _C LEAR _UNKNO WN_V
MS
Info
34 9
USER _FAILED _C LEAR _UN
KNO WN_VMS
Erro r
350
USER _AD D _BO O KMAR K
Info
351
USER _AD D _BO O KMAR K_FA
ILED
Erro r
352
USER _UP D AT E_BO O KMAR K
Info
353
USER _UP D AT E_BO O KMAR K
_FAILED
Erro r
354
USER _R EMO VE_BO O KMAR K
Info
355
USER _R EMO VE_BO O KMAR K
_FAILED
Erro r
356
USER _R EMO VE_SNAP SHO T
_FINISHED _SUC C ESS
Info
357
USER _R EMO VE_SNAP SHO T
_FINISHED _FAILUR E
Erro r
358
USER _VM_P O O L_MAX_SUB
SEQ UENT _FAILUR ES_R EA
C HED
Warni ng
Snapsho t ' ${Snapsho tName}'
d el eti o n fo r VM ' ${VmName}'
was i ni ti ated by
${UserName}.
Fai l ed to remo ve Snapsho t
${Snapsho tName} fo r VM
${VmName} (User:
${UserName}).
VM P o o l ${VmP o o l Name} was
upd ated by ${UserName},
${VmsC o unt} VMs were ad d ed .
Fai l ed to upd ate VM P o o l
${VmP o o l Name}(User:
${UserName}).
P asswo rd chang ed
successful l y fo r ${UserName}
Fai l ed to chang e passwo rd .
(User: ${UserName})
Al l VMs' status o n No n
R espo nsi ve Ho st ${Vd sName}
were chang ed to ' D o wn' by
${UserName}
Fai l ed to cl ear VMs' status
o n No n R espo nsi ve Ho st
${Vd sName}. (User:
${UserName}).
Bo o kmark ${Bo o kmarkName} was
ad d ed by ${UserName}.
Fai l ed to ad d bo o kmark:
${Bo o kmarkName} (User:
${UserName}).
Bo o kmark ${Bo o kmarkName} was
upd ated by ${UserName}.
Fai l ed to upd ate bo o kmark:
${Bo o kmarkName} (User:
${UserName})
Bo o kmark ${Bo o kmarkName} was
remo ved by ${UserName}.
Fai l ed to remo ve bo o kmark
${Bo o kmarkName} (User:
${UserName})
Snapsho t ' ${Snapsho tName}'
d el eti o n fo r VM ' ${VmName}'
has been co mpl eted .
Fai l ed to d el ete snapsho t
' ${Snapsho tName}' fo r VM
' ${VmName}' .
No t al l VMs where
successful l y created i n VM
P o o l ${VmP o o l Name}.
34 7
34 8
252
Erro r
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
359
USER _R EMO VE_SNAP SHO T
_FINISHED _FAILUR E_P A
R T IAL_SNAP SHO T
Warni ng
36 0
USER _D ET AC H_USER _FR O
M_VM
Info
36 1
USER _FAILED _D ET AC H_U
SER _FR O M_VM
Erro r
370
USER _EXT END _D ISK_SIZ
E_FAILUR E
Erro r
371
USER _EXT END _D ISK_SIZ
E_SUC C ESS
Info
372
USER _EXT END _D ISK_SIZ
E_UP D AT E_VM_FAILUR E
Warni ng
373
USER _R EMO VE_D ISK_SNA
P SHO T
Info
374
USER _FAILED _R EMO VE_D
ISK_SNAP SHO T
Erro r
375
USER _R EMO VE_D ISK_SNA
P SHO T _FINISHED _SUC C E
SS
Info
376
USER _R EMO VE_D ISK_SNA
P SHO T _FINISHED _FAILU
RE
Erro r
377
USER _EXT END ED _D ISK_S
IZE
Info
378
USER _R EG IST ER _D ISK_F
INISHED _SUC C ESS
Info
D ue to parti al snapsho t
remo val , Snapsho t
' ${Snapsho tName}' o f VM
' ${VmName}' no w co ntai ns
o nl y the fo l l o wi ng d i sks:
' ${D i skAl i ases}' .
User ${Ad UserName} was
d etached fro m VM ${VmName}
by ${UserName}.
Fai l ed to d etach User
${Ad UserName} fro m VM
${VmName} (User:
${UserName}).
Fai l ed to extend si ze o f the
d i sk ' ${D i skAl i as}' to
${NewSi ze} G B, User:
${UserName}.
Si ze o f the d i sk
' ${D i skAl i as}' was
successful l y upd ated to
${NewSi ze} G B by
${UserName}.
Fai l ed to upd ate VM
' ${VmName}' wi th the new
vo l ume si ze. VM restart i s
reco mmend ed .
D i sk ' ${D i skAl i as}' fro m
Snapsho t(s) ' ${Snapsho ts}'
o f VM ' ${VmName}' d el eti o n
was i ni ti ated by
${UserName}.
Fai l ed to d el ete D i sk
' ${D i skAl i as}' fro m
Snapsho t(s) ${Snapsho ts} o f
VM ${VmName} (User:
${UserName}).
D i sk ' ${D i skAl i as}' fro m
Snapsho t(s) ' ${Snapsho ts}'
o f VM ' ${VmName}' d el eti o n
has been co mpl eted (User:
${UserName}).
Fai l ed to co mpl ete d el eti o n
o f D i sk ' ${D i skAl i as}' fro m
snapsho t(s) ' ${Snapsho ts}'
o f VM ' ${VmName}' (User:
${UserName}).
Extend i ng d i sk
' ${D i skAl i as}' to ${NewSi ze}
G B was i ni ti ated by
${UserName}.
D i sk ' ${D i skAl i as}' has
been successful l y reg i stered
as a fl o ati ng d i sk.
253
REST API ガイド
コード
名前
重大度
メッセージ
379
USER _R EG IST ER _D ISK_F
INISHED _FAILUR E
USER _EXT END _D ISK_SIZ
E_UP D AT E_HO ST _FAILUR
E
Erro r
400
USER _AT T AC H_VM_T O _AD
_G R O UP
Info
401
USER _AT T AC H_VM_T O _AD
_G R O UP _FAILED
Erro r
402
USER _D ET AC H_VM_T O _AD
_G R O UP
Info
403
USER _D ET AC H_VM_T O _AD
_G R O UP _FAILED
Erro r
404
USER _AT T AC H_VM_P O O L_
T O _AD _G R O UP
Info
405
USER _AT T AC H_VM_P O O L_
T O _AD _G R O UP _FAILED
Erro r
406
USER _D ET AC H_VM_P O O L_
T O _AD _G R O UP
Info
407
USER _D ET AC H_VM_P O O L_
T O _AD _G R O UP _FAILED
Erro r
408
USER _R EMO VE_AD _G R O UP
Info
409
USER _R EMO VE_AD _G R O UP
_FAILED
Erro r
4 30
USER _UP D AT E_T AG
Info
4 31
USER _UP D AT E_T AG _FAIL
ED
Erro r
4 32
USER _AD D _T AG
Info
4 33
USER _AD D _T AG _FAILED
Erro r
4 34
USER _R EMO VE_T AG
Info
Fai l ed to reg i ster D i sk
' ${D i skAl i as}' .
Fai l ed to refresh vo l ume
si ze o n ho st ' ${Vd sName}' .
P l ease try the o perati o n
ag ai n.
G ro up ${G ro upName} was
attached to VM ${VmName} by
${UserName}.
Fai l ed to attach G ro up
${G ro upName} to VM ${VmName}
(User: ${UserName}).
G ro up ${G ro upName} was
d etached fro m VM ${VmName}
by ${UserName}.
Fai l ed to d etach G ro up
${G ro upName} fro m VM
${VmName} (User:
${UserName}).
G ro up ${G ro upName} was
attached to VM P o o l
${VmP o o l Name} by
${UserName}.
Fai l ed to attach G ro up
${G ro upName} to VM P o o l
${VmP o o l Name} (User:
${UserName}).
G ro up ${G ro upName} was
d etached fro m VM P o o l
${VmP o o l Name} by
${UserName}.
Fai l ed to d etach G ro up
${G ro upName} fro m VM P o o l
${VmP o o l Name} (User:
${UserName}).
G ro up ${G ro upName} was
remo ved by ${UserName}.
Fai l ed to remo ve g ro up
${G ro upName} (User:
${UserName}).
T ag ${T ag Name} co nfi g urati o n
was upd ated by ${UserName}.
Fai l ed to upd ate T ag
${T ag Name} (User:
${UserName}).
New T ag ${T ag Name} was
created by ${UserName}.
Fai l ed to create T ag named
${T ag Name} (User:
${UserName}).
T ag ${T ag Name} was remo ved
by ${UserName}.
380
254
Warni ng
⁠付録C イベントコード
コード
名前
重大度
メッセージ
4 35
USER _R EMO VE_T AG _FAIL
ED
Erro r
4 36
USER _AT T AC H_T AG _T O _U
SER
Info
4 37
USER _AT T AC H_T AG _T O _U
SER _FAILED
Erro r
4 38
USER _AT T AC H_T AG _T O _U
SER _G R O UP
Info
4 39
USER _AT T AC H_T AG _T O _U
SER _G R O UP _FAILED
Erro r
440
USER _AT T AC H_T AG _T O _V
M
Info
441
USER _AT T AC H_T AG _T O _V
M_FAILED
Erro r
442
USER _AT T AC H_T AG _T O _V
DS
Info
443
USER _AT T AC H_T AG _T O _V
D S_FAILED
Erro r
444
USER _D ET AC H_VD S_FR O M
_T AG
Info
445
USER _D ET AC H_VD S_FR O M
_T AG _FAILED
Erro r
446
USER _D ET AC H_VM_FR O M_
T AG
Info
447
USER _D ET AC H_VM_FR O M_
T AG _FAILED
Erro r
448
USER _D ET AC H_USER _FR O
M_T AG
Info
Fai l ed to remo ve T ag
${T ag Name} (User:
${UserName}).
T ag ${T ag Name} was attached
to User(s)
${AttachUsersNames} by
${UserName}.
Fai l ed to attach T ag
${T ag Name} to User(s)
${AttachUsersNames} (User:
${UserName}).
T ag ${T ag Name} was attached
to G ro up(s)
${AttachG ro upsNames} by
${UserName}.
Fai l ed to attach G ro up(s)
${AttachG ro upsNames} to T ag
${T ag Name} (User:
${UserName}).
T ag ${T ag Name} was attached
to VM(s) ${VmsNames} by
${UserName}.
Fai l ed to attach T ag
${T ag Name} to VM(s)
${VmsNames} (User:
${UserName}).
T ag ${T ag Name} was attached
to Ho st(s) ${Vd sNames} by
${UserName}.
Fai l ed to attach T ag
${T ag Name} to Ho st(s)
${Vd sNames} (User:
${UserName}).
T ag ${T ag Name} was d etached
fro m Ho st(s) ${Vd sNames} by
${UserName}.
Fai l ed to d etach T ag
${T ag Name} fro m Ho st(s)
${Vd sNames} (User:
${UserName}).
T ag ${T ag Name} was d etached
fro m VM(s) ${VmsNames} by
${UserName}.
Fai l ed to d etach T ag
${T ag Name} fro m VM(s)
${VmsNames} (User:
${UserName}).
T ag ${T ag Name} d etached fro m
User(s) ${D etachUsersNames}
by ${UserName}.
255
REST API ガイド
コード
名前
重大度
メッセージ
449
USER _D ET AC H_USER _FR O
M_T AG _FAILED
Erro r
4 50
USER _D ET AC H_USER _G R O
UP _FR O M_T AG
Info
4 51
USER _D ET AC H_USER _G R O
UP _FR O M_T AG _FAILED
Erro r
4 52
USER _AT T AC H_T AG _T O _U
SER _EXIST S
Warni ng
4 53
USER _AT T AC H_T AG _T O _U
SER _G R O UP _EXIST S
Warni ng
4 54
USER _AT T AC H_T AG _T O _V
M_EXIST S
Warni ng
4 55
USER _AT T AC H_T AG _T O _V
D S_EXIST S
Warni ng
4 56
USER _LO G G ED _IN_VM
Info
4 57
USER _LO G G ED _O UT _VM
Info
4 58
USER _LO C KED _VM
Info
4 59
USER _UNLO C KED _VM
Info
460
USER _AT T AC H_T AG _T O _T
EMP LAT E_EXIST S
Warni ng
467
UP D AT E_T AG S_VM_D EFAU Info
LT _D ISP LAY _T Y P E
UP D AT E_T AG S_VM_D EFAU Info
LT _D ISP LAY _T Y P E_FAIL
ED
USER _AT T AC H_VM_P O O L_ Info
T O _AD _G R O UP _INT ER NAL
Fai l ed to d etach T ag
${T ag Name} fro m User(s)
${D etachUsersNames} (User:
${UserName}).
T ag ${T ag Name} was d etached
fro m G ro up(s)
${D etachG ro upsNames} by
${UserName}.
Fai l ed to d etach T ag
${T ag Name} fro m G ro up(s)
${D etachG ro upsNames} (User:
${UserName}).
T ag ${T ag Name} al read y
attached to User(s)
${AttachUsersNamesExi sts}.
T ag ${T ag Name} al read y
attached to G ro up(s)
${AttachG ro upsNamesExi sts}.
T ag ${T ag Name} al read y
attached to VM(s)
${VmsNamesExi sts}.
T ag ${T ag Name} al read y
attached to Ho st(s)
${Vd sNamesExi sts}.
User ${G uestUser} l o g g ed i n
to VM ${VmName}.
User ${G uestUser} l o g g ed o ut
fro m VM ${VmName}.
User ${G uestUser} l o cked VM
${VmName}.
User ${G uestUser} unl o cked
VM ${VmName}.
T ag ${T ag Name} al read y
attached to T empl ate(s)
${T empl atesNamesExi sts}.
Vm ${VmName} tag d efaul t
d i spl ay type was upd ated
Fai l ed to upd ate Vm
${VmName} tag d efaul t
d i spl ay type
G ro up ${G ro upName} was
attached to VM P o o l
${VmP o o l Name}.
Fai l ed to attach G ro up
${G ro upName} to VM P o o l
${VmP o o l Name}.
User ${Ad UserName} was
attached to VM P o o l
${VmP o o l Name}.
468
4 70
4 71
4 72
256
USER _AT T AC H_VM_P O O L_
T O _AD _G R O UP _FAILED _I
NT ER NAL
USER _AT T AC H_USER _T O _
P O O L_INT ER NAL
Erro r
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
4 73
USER _AT T AC H_USER _T O _
P O O L_FAILED _INT ER NAL
Erro r
493
VD S_ALR EAD Y _IN_R EQ UE
ST ED _ST AT US
Warni ng
494
VD S_MANUAL_FENC E_ST A
T US
VD S_MANUAL_FENC E_ST A
T US_FAILED
VD S_FENC E_ST AT US
Info
Erro r
498
VD S_FENC E_ST AT US_FAI
LED
VD S_AP P R O VE
499
VD S_AP P R O VE_FAILED
Erro r
50 0
VD S_FAILED _T O _R UN_VM
S
Erro r
50 1
USER _SUSP END _VM
Info
50 2
USER _FAILED _SUSP END _
VM
Erro r
50 3
USER _SUSP END _VM_O K
Info
50 4
50 5
VD S_INST ALL
VD S_INST ALL_FAILED
Info
Erro r
50 6
VD S_INIT IAT ED _R UN_VM
Info
50 9
VD S_INST ALL_IN_P R O G R
ESS
VD S_INST ALL_IN_P R O G R
ESS_WAR NING
VD S_INST ALL_IN_P R O G R
ESS_ER R O R
USER _SUSP END _VM_FINI
SH_SUC C ESS
VD S_R EC O VER _FAILED _V
MS_UNKNO WN
Info
Fai l ed to attach User
${Ad UserName} to VM P o o l
${VmP o o l Name} (User:
${UserName}).
Ho st ${Ho stName} i s al read y
${Ag entStatus}, P o wer
Manag ement ${O perati o n}
o perati o n ski pped .
Manual fence fo r ho st
${Vd sName} was started .
Manual fence fo r ho st
${Vd sName} fai l ed .
Ho st ${Vd sName} po wer
manag ement was veri fi ed
successful l y.
Fai l ed to veri fy Ho st
${Vd sName} po wer manag ement.
Ho st ${Vd sName} was
successful l y appro ved by
user ${UserName}.
Fai l ed to appro ve Ho st
${Vd sName}.
Ho st ${Vd sName} wi l l be
swi tched to Erro r status fo r
${T i me} mi nutes because i t
fai l ed to run a VM.
Suspend i ng VM ${VmName} was
i ni ti ated by User ${UserName}
(Ho st: ${Vd sName}).
Fai l ed to suspend VM
${VmName} (Ho st:
${Vd sName}).
VM ${VmName} o n Ho st
${Vd sName} i s suspend ed .
Ho st ${Vd sName} i nstal l ed
Ho st ${Vd sName} i nstal l ati o n
fai l ed .
${Fai l ed Instal l Messag e}.
VM ${VmName} was restarted o n
Ho st ${Vd sName}
Instal l i ng Ho st ${Vd sName}.
${Messag e}.
Ho st ${Vd sName} i nstal l ati o n
i n pro g ress . ${Messag e}.
Fai l ed to i nstal l Ho st
${Vd sName}. ${Messag e}.
Suspend i ng VM ${VmName} has
been co mpl eted .
Ho st ${Vd sName} canno t be
reached , VMs state o n thi s
ho st are marked as Unkno wn.
495
496
497
510
511
512
513
Erro r
Info
Info
Warni ng
Erro r
Info
Erro r
257
REST API ガイド
コード
名前
重大度
メッセージ
514
VD S_INIT IALIZING
Warni ng
515
VD S_C P U_LO WER _T HAN_C
LUST ER
Warni ng
516
VD S_C P U_R ET R IEVE_FAI
LED
Warni ng
517
VD S_SET _NO NO P ER AT IO N
AL
VD S_SET _NO NO P ER AT IO N
AL_FAILED
Info
519
VD S_SET _NO NO P ER AT IO N
AL_NET WO R K
Warni ng
520
USER _AT T AC H_USER _T O _
VM
Info
521
USER _SUSP END _VM_FINI
SH_FAILUR E
VD S_SET _NO NO P ER AT IO N
AL_D O MAIN
Erro r
523
VD S_SET _NO NO P ER AT IO N
AL_D O MAIN_FAILED
Erro r
524
VD S_D O MAIN_D ELAY _INT
ER VAL
Warni ng
Ho st ${Vd sName} i s
i ni ti al i zi ng . Messag e:
${Erro rMessag e}
Ho st ${Vd sName} mo ved to
No n-O perati o nal state as
ho st d o es no t meet the
cl uster' s mi ni mum C P U
l evel . Mi ssi ng C P U features
: ${C puFl ag s}
Fai l ed to d etermi ne Ho st
${Vd sName} C P U l evel co ul d no t retri eve C P U
fl ag s.
Ho st ${Vd sName} mo ved to
No n-O perati o nal state.
Fai l ed to mo ve Ho st
${Vd sName} to No nO perati o nal state.
Ho st ${Vd sName} d o es no t
co mpl y wi th the cl uster
${Vd sG ro upName} netwo rks, the
fo l l o wi ng netwo rks are
mi ssi ng o n ho st:
' ${Netwo rks}'
User ${Ad UserName} was
attached to VM ${VmName} by
${UserName}.
Fai l ed to co mpl ete
suspend i ng o f VM ${VmName}.
Ho st ${Vd sName} canno t
access the Sto rag e D o mai n(s)
${Sto rag eD o mai nNames}
attached to the D ata C enter
${Sto rag eP o o l Name}. Setti ng
Ho st state to No nO perati o nal .
Ho st ${Vd sName} canno t
access the Sto rag e D o mai n(s)
${Sto rag eD o mai nNames}
attached to the D ata C enter
${Sto rag eP o o l Name}. Fai l ed
to set Ho st state to No nO perati o nal .
Sto rag e d o mai n
${Sto rag eD o mai nName}
experi enced a hi g h l atency
o f ${D el ay} seco nd s fro m
ho st ${Vd sName}. T hi s may
cause perfo rmance and
functi o nal i ssues. P l ease
co nsul t yo ur Sto rag e
Ad mi ni strato r.
518
522
258
Erro r
Warni ng
⁠付録C イベントコード
コード
名前
重大度
メッセージ
525
Info
Starti ng VM ${VmName} as
statel ess was i ni ti ated .
528
VD S_INIT IAT ED _R UN_AS
_ST AT ELESS_VM_NO T _Y E
T _R UNNING
USER _EJEC T _VM_D ISK
Info
529
USER _EJEC T _VM_FLO P P Y
Info
530
VD S_MANUAL_FENC E_FAIL Warni ng
ED _C ALL_FENC E_SP M
531
VD S_LO W_MEM
Warni ng
532
VD S_HIG H_MEM_USE
Warni ng
C D was ejected fro m VM
${VmName} by ${UserName}.
Fl o ppy was ejected fro m VM
${VmName} by ${UserName}
Manual fence d i d no t revo ke
the sel ected SP M
(${Vd sName}) si nce the master
sto rag e d o mai n\n was no t
acti ve o r co ul d no t use
ano ther ho st fo r the fence
o perati o n.
Avai l abl e memo ry o f ho st
${Ho stName}
[${Avai l abl eMemo ry} MB] i s
und er d efi ned thresho l d
[${T hresho l d } MB].
Used memo ry o f ho st
${Ho stName} [${Used Memo ry}%]
exceed ed d efi ned thresho l d
[${T hresho l d }%].
533
534
VD S_HIG H_NET WO R K_USE
VD S_HIG H_C P U_USE
Warni ng
Warni ng
535
VD S_HIG H_SWAP _USE
Warni ng
536
VD S_LO W_SWAP
Warni ng
537
VD S_INIT IAT ED _R UN_VM
_AS_ST AT ELESS
USER _R UN_VM_AS_ST AT E
LESS
VD S_AUT O _FENC E_ST AT U
S
VD S_AUT O _FENC E_ST AT U
S_FAILED
VD S_AUT O _FENC E_FAILE
D _C ALL_FENC E_SP M
Info
538
539
54 0
54 1
Info
Info
Erro r
Warni ng
Used C P U o f ho st ${Ho stName}
[${Used C pu}%] exceed ed
d efi ned thresho l d
[${T hresho l d }%].
Used swap memo ry o f ho st
${Ho stName} [${Used Swap}%]
exceed ed d efi ned thresho l d
[${T hresho l d }%].
Avai l abl e swap memo ry o f
ho st ${Ho stName}
[${Avai l abl eSwapMemo ry} MB]
i s und er d efi ned thresho l d
[${T hresho l d } MB].
VM ${VmName} was restarted o n
Ho st ${Vd sName} as statel ess
VM ${VmName} started o n Ho st
${Vd sName} as statel ess
Auto fence fo r ho st
${Vd sName} was started .
Auto fence fo r ho st
${Vd sName} fai l ed .
Auto fence d i d no t revo ke
the sel ected SP M
(${Vd sName}) si nce the master
sto rag e d o mai n\n was no t
acti ve o r co ul d no t use
ano ther ho st fo r the fence
o perati o n.
259
REST API ガイド
コード
名前
重大度
メッセージ
550
VD S_P AC KAG ES_IN_P R O G
R ESS
VD S_P AC KAG ES_IN_P R O G
R ESS_WAR NING
Info
Erro r
555
VD S_P AC KAG ES_IN_P R O G
R ESS_ER R O R
USER _MO VE_T AG
556
USER _MO VE_T AG _FAILED
Erro r
600
USER _VD S_MAINT ENANC E
Info
601
C P U_FLAG S_NX_IS_MISS
ING
Warni ng
602
USER _VD S_MAINT ENANC E
_MIG R AT IO N_FAILED
Warni ng
603
VD S_SET _NO NO P ER AT IO N
AL_IFAC E_D O WN
Warni ng
604
VD S_T IME_D R IFT _ALER T
Warni ng
P ackag e upd ate Ho st
${Vd sName}. ${Messag e}.
Ho st ${Vd sName} upd ate
packag es i n pro g ress .
${Messag e}.
Fai l ed to upd ate packag es
Ho st ${Vd sName}. ${Messag e}.
T ag ${T ag Name} was mo ved
fro m ${O l d P arnetT ag Name} to
${NewP arentT ag Name} by
${UserName}.
Fai l ed to mo ve T ag
${T ag Name} fro m
${O l d P arnetT ag Name} to
${NewP arentT ag Name} (User:
${UserName}).
Ho st ${Vd sName} was swi tched
to Mai ntenance mo d e by
${UserName} (R easo n:
${R easo n}).
Ho st ${Vd sName} i s mi ssi ng
the NX cpu fl ag . T hi s fl ag
can be enabl ed vi a the ho st
BIO S. P l ease set D i sabl e
Execute (XD ) fo r an Intel
ho st, o r No Execute (NX) fo r
AMD . P l ease make sure to
co mpl etel y po wer o ff the
ho st fo r thi s chang e to take
effect.
Ho st ${Vd sName} canno t
chang e i nto mai ntenance mo d e
- no t al l Vms have been
mi g rated successful l y.
C o nsi d er manual
i nterventi o n:
sto ppi ng /mi g rati ng Vms:
${fai l ed Vms} (User:
${UserName}).
Ho st ${Vd sName} mo ved to
No n-O perati o nal state
because i nterfaces whi ch are
d o wn are need ed by req ui red
netwo rks i n the current
cl uster:
' ${Ni csWi thNetwo rks}' .
Ho st ${Vd sName} has ti med ri ft o f ${Actual } seco nd s
whi l e maxi mum co nfi g ured
val ue i s ${Max} seco nd s.
551
552
260
Warni ng
Info
⁠付録C イベントコード
コード
名前
605
P R O XY _HO ST _SELEC T IO N Info
606
HO ST _R EFR ESHED _C AP AB
ILIT IES
Info
607
HO ST _R EFR ESH_C AP ABIL
IT IES_FAILED
Erro r
608
HO ST _INT ER FAC E_HIG H_
NET WO R K_USE
Warni ng
609
HO ST _INT ER FAC E_ST AT E
_UP
No rmal
6 10
HO ST _INT ER FAC E_ST AT E
_D O WN
Warni ng
6 11
HO ST _BO ND _SLAVE_ST AT
E_UP
No rmal
6 12
HO ST _BO ND _SLAVE_ST AT
E_D O WN
Warni ng
6 13
FENC E_KD UMP _LIST ENER
_IS_NO T _ALIVE
Erro r
6 14
KD UMP _FLO W_D ET EC T ED _
O N_VD S
KD UMP _FLO W_NO T _D ET EC
T ED _O N_VD S
KD UMP _FLO W_FINISHED _
O N_VD S
KD UMP _D ET EC T IO N_NO T _
C O NFIG UR ED _O N_VD S
Info
6 18
HO ST _R EG IST R AT IO N_FA
ILED _INVALID _C LUST ER
Info
70 0
D ISK_ALIG NMENT _SC AN_
ST AR T
Info
6 15
6 16
6 17
重大度
Info
Info
Warni ng
メッセージ
Ho st ${P ro xy} fro m ${O ri g i n}
was cho sen as a pro xy to
execute fenci ng o n Ho st
${Vd sName}.
Successful l y refreshed the
capabi l i ti es o f ho st
${Vd sName}.
Fai l ed to refresh the
capabi l i ti es o f ho st
${Vd sName}.
Ho st ${Ho stName} has netwo rk
i nterface whi ch exceed ed the
d efi ned thresho l d
[${T hresho l d }%]
(${InterfaceName}: transmi t
rate[${T ransmi tR ate}%],
recei ve rate
[${R ecei veR ate}%])
Interface ${InterfaceName} o n
ho st ${Vd sName}, chang ed
state to up
Interface ${InterfaceName} o n
ho st ${Vd sName}, chang ed
state to d o wn
Sl ave ${Sl aveName} o f bo nd
${Bo nd Name} o n ho st
${Vd sName}, chang ed state to
up
Sl ave ${Sl aveName} o f bo nd
${Bo nd Name} o n ho st
${Vd sName}, chang ed state to
d o wn
Unabl e to d etermi ne i f Kd ump
i s i n pro g ress o n ho st
${Vd sName}, because
fence_kd ump l i stener i s no t
runni ng .
Kd ump fl o w i s i n pro g ress o n
ho st ${Vd sName}.
Kd ump fl o w i s no t i n
pro g ress o n ho st ${Vd sName}.
Kd ump fl o w fi ni shed o n ho st
${Vd sName}.
Kd ump i nteg rati o n i s enabl ed
fo r ho st ${Vd sName}, but
kd ump i s no t co nfi g ured
pro perl y o n ho st.
No d efaul t o r val i d cl uster
was fo und , Ho st ${Vd sName}
reg i strati o n fai l ed
Starti ng al i g nment scan o f
d i sk ' ${D i skAl i as}' .
261
REST API ガイド
コード
名前
重大度
メッセージ
70 1
D ISK_ALIG NMENT _SC AN_
FAILUR E
D ISK_ALIG NMENT _SC AN_
SUC C ESS
USER _AD D _VD S_G R O UP
Warni ng
USER _AD D _VD S_G R O UP _F
AILED
USER _UP D AT E_VD S_G R O U
P
USER _UP D AT E_VD S_G R O U
P _FAILED
USER _R EMO VE_VD S_G R O U
P
USER _R EMO VE_VD S_G R O U
P _FAILED
USER _VD C _LO G O UT _FAIL
ED
MAC _P O O L_EMP T Y
Erro r
C ER T IFIC AT E_FILE_NO T
_FO UND
R UN_VM_FAILED
Erro r
Al i g nment scan o f d i sk
' ${D i skAl i as}' fai l ed .
Al i g nment scan o f d i sk
' ${D i skAl i as}' i s co mpl ete.
C l uster ${Vd sG ro upName} was
ad d ed by ${UserName}
Fai l ed to ad d Ho st cl uster
(User: ${UserName})
Ho st cl uster ${Vd sG ro upName}
was upd ated by ${UserName}
Fai l ed to upd ate Ho st
cl uster (User: ${UserName})
Ho st cl uster ${Vd sG ro upName}
was remo ved by ${UserName}
Fai l ed to remo ve Ho st
cl uster (User: ${UserName})
Fai l ed to l o g User
${UserName} o ut.
No MAC ad d resses l eft i n the
MAC Ad d ress P o o l .
C o ul d no t fi nd o Vi rt Eng i ne
C erti fi cate fi l e.
C anno t run VM ${VmName} o n
Ho st ${Vd sName}. Erro r:
${ErrMsg }
Ho st reg i strati o n fai l ed canno t upd ate Ho st Name fo r
Ho st ${Vd sName2}. (Ho st:
${Vd sName1})
Ho st reg i strati o n fai l ed al l avai l abl e Ho st Names are
taken. (Ho st: ${Vd sName1})
Ho st reg i strati o n fai l ed canno t chang e Ho st Name o f
acti ve Ho st ${Vd sName2}.
(Ho st: ${Vd sName1})
Ho st reg i strati o n fai l ed canno t upd ate Ho st Name fo r
Ho st ${Vd sName2}. (Ho st:
${Vd sName1})
Ho st reg i strati o n fai l ed al l avai l abl e Ho st Names are
taken. (Ho st: ${Vd sName1})
Ho st reg i strati o n fai l ed canno t chang e Ho st Name o f
acti ve Ho st ${Vd sName2}.
(Ho st: ${Vd sName1})
Ho st reg i strati o n fai l ed auto appro ve pattern erro r.
(Ho st: ${Vd sName1})
Ho st reg i strati o n fai l ed .
(Ho st: ${Vd sName1})
70 2
80 9
810
811
812
813
814
815
816
817
818
Info
Info
Info
Erro r
Info
Erro r
Erro r
Warni ng
Erro r
819
VD S_R EG IST ER _ER R O R _U Erro r
P D AT ING _HO ST
820
VD S_R EG IST ER _ER R O R _U Erro r
P D AT ING _HO ST _ALL_T AK
EN
VD S_R EG IST ER _HO ST _IS Erro r
_AC T IVE
821
822
VD S_R EG IST ER _ER R O R _U Erro r
P D AT ING _NAME
823
VD S_R EG IST ER _ER R O R _U Erro r
P D AT ING _NAMES_ALL_T A
KEN
VD S_R EG IST ER _NAME_IS Erro r
_AC T IVE
824
825
VD S_R EG IST ER _AUT O _AP
P R O VE_P AT T ER N
Erro r
826
VD S_R EG IST ER _FAILED
Erro r
262
⁠付録C イベントコード
コード
名前
重大度
メッセージ
827
VD S_R EG IST ER _EXIST IN
G _VD S_UP D AT E_FAILED
Erro r
828
VD S_R EG IST ER _SUC C EED
ED
VM_MIG R AT IO N_O N_C O NN
EC T _C HEC K_FAILED
VM_MIG R AT IO N_O N_C O NN
EC T _C HEC K_SUC C EED ED
USER _VD C _SESSIO N_T ER
MINAT ED
Info
Ho st reg i strati o n fai l ed canno t upd ate exi sti ng Ho st.
(Ho st: ${Vd sName1})
Ho st ${Vd sName1} reg i stered .
832
USER _VD C _SESSIO N_T ER
MINAT IO N_FAILED
Erro r
833
MAC _AD D R ESS_IS_IN_US
E
Warni ng
834
VD S_R EG IST ER _EMP T Y _I
D
Warni ng
835
SY ST EM_UP D AT E_VD S_G R
O UP
SY ST EM_UP D AT E_VD S_G R
O UP _FAILED
MAC _AD D R ESSES_P O O L_N
O T _INIT IALIZED
MAC _AD D R ESS_IS_IN_US
E_UNP LUG
Info
HO ST _UP G R AD E_ST AR T E
D
HO ST _UP G R AD E_FAILED
Info
HO ST _UP G R AD E_FINISHE
D
HO ST _C ER T IFIC AT IO N_I
S_ABO UT _T O _EXP IR E
Info
ENG INE_C ER T IFIC AT IO N
_HAS_EXP IR ED
Info
829
830
831
836
837
838
84 0
84 1
84 2
84 5
84 6
Erro r
Info
Info
Info
Warni ng
Warni ng
Erro r
Warni ng
VM mi g rati o n l o g i c fai l ed .
(VM name: ${VmName})
Mi g rati o n check fai l ed to
execute.
User ${UserName} fo rci bl y
l o g o ut user
${T ermi nated Sessi o nUsername}
.
User ${UserName} fai l ed to
fo rci bl y l o g o ut user
${T ermi nated Sessi o nUsername}
.
Netwo rk Interface
${IfaceName} has MAC ad d ress
${MAC Ad d r} whi ch i s i n use.
Ho st reg i strati o n fai l ed ,
empty ho st i d (Ho st:
${Vd sHo stName})
Ho st cl uster ${Vd sG ro upName}
was upd ated by system
Fai l ed to upd ate Ho st
cl uster by system
Mac Ad d ress P o o l i s no t
i ni ti al i zed . ${Messag e}
Netwo rk Interface
${IfaceName} has MAC ad d ress
${MAC Ad d r} whi ch i s i n use,
therefo re i t i s bei ng
unpl ug g ed fro m VM ${VmName}.
Ho st ${Vd sName} upg rad e was
started (User: ${UserName}).
Fai l ed to upg rad e Ho st
${Vd sName} (User:
${UserName}).
Ho st ${Vd sName} upg rad e was
co mpl eted successful l y.
Ho st ${Vd sName}
certi fi cati o n i s abo ut to
expi re at ${Expi rati o nD ate}.
P l ease renew the ho st' s
certi fi cati o n.
Eng i ne' s certi fi cati o n has
expi red at
${Expi rati o nD ate}. P l ease
renew the eng i ne' s
certi fi cati o n.
263
REST API ガイド
コード
名前
重大度
メッセージ
84 7
ENG INE_C ER T IFIC AT IO N
_IS_ABO UT _T O _EXP IR E
Warni ng
84 8
ENG INE_C A_C ER T IFIC AT
IO N_HAS_EXP IR ED
Info
84 9
ENG INE_C A_C ER T IFIC AT
IO N_IS_ABO UT _T O _EXP I
RE
USER _AD D _P ER MISSIO N
Warni ng
851
USER _AD D _P ER MISSIO N_
FAILED
Erro r
852
USER _R EMO VE_P ER MISSI
ON
Info
853
USER _R EMO VE_P ER MISSI
O N_FAILED
Erro r
854
USER _AD D _R O LE
Info
855
USER _AD D _R O LE_FAILED
Erro r
856
USER _UP D AT E_R O LE
Info
857
USER _UP D AT E_R O LE_FAI
LED
USER _R EMO VE_R O LE
Erro r
USER _R EMO VE_R O LE_FAI
LED
Erro r
Eng i ne' s certi fi cati o n i s
abo ut to expi re at
${Expi rati o nD ate}. P l ease
renew the eng i ne' s
certi fi cati o n.
Eng i ne' s C A certi fi cati o n
has expi red at
${Expi rati o nD ate}.
Eng i ne' s C A certi fi cati o n i s
abo ut to expi re at
${Expi rati o nD ate}.
User/G ro up ${SubjectName},
Namespace ${Namespace},
Autho ri zati o n pro vi d er:
${Authz} was g ranted
permi ssi o n fo r R o l e
${R o l eName} o n
${Vd cO bjectT ype}
${Vd cO bjectName}, by
${UserName}.
User ${UserName} fai l ed to
g rant permi ssi o n fo r R o l e
${R o l eName} o n
${Vd cO bjectT ype}
${Vd cO bjectName} to
User/G ro up ${SubjectName}.
User/G ro up ${SubjectName}
R o l e ${R o l eName} permi ssi o n
was remo ved fro m
${Vd cO bjectT ype}
${Vd cO bjectName} by
${UserName}
User ${UserName} fai l ed to
remo ve permi ssi o n fo r R o l e
${R o l eName} fro m
${Vd cO bjectT ype}
${Vd cO bjectName} to
User/G ro up ${SubjectName}
R o l e ${R o l eName} g ranted to
${UserName}
Fai l ed to g rant ro l e
${R o l eName} (User
${UserName})
${UserName} R o l e was upd ated
to the ${R o l eName} R o l e
Fai l ed to upd ate ro l e
${R o l eName} to ${UserName}
R o l e ${R o l eName} remo ved
fro m ${UserName}
Fai l ed to remo ve ro l e
${R o l eName} (User
${UserName})
850
858
859
264
Info
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
86 0
USER _AT T AC HED _AC T IO N
_G R O UP _T O _R O LE
Info
86 1
USER _AT T AC HED _AC T IO N
_G R O UP _T O _R O LE_FAILE
D
Erro r
86 2
USER _D ET AC HED _AC T IO N
_G R O UP _FR O M_R O LE
Info
86 3
USER _D ET AC HED _AC T IO N
_G R O UP _FR O M_R O LE_FAI
LED
USER _AD D _R O LE_WIT H_A
C T IO N_G R O UP
USER _AD D _R O LE_WIT H_A
C T IO N_G R O UP _FAILED
USER _AD D _SY ST EM_P ER M
ISSIO N
Erro r
86 7
USER _AD D _SY ST EM_P ER M
ISSIO N_FAILED
Erro r
86 8
USER _R EMO VE_SY ST EM_P
ER MISSIO N
Info
86 9
USER _R EMO VE_SY ST EM_P
ER MISSIO N_FAILED
Erro r
870
USER _AD D _P R O FILE
Info
871
USER _AD D _P R O FILE_FAI
LED
USER _UP D AT E_P R O FILE
Erro r
USER _UP D AT E_P R O FILE_
FAILED
USER _R EMO VE_P R O FILE
Erro r
USER _R EMO VE_P R O FILE_
FAILED
Erro r
Acti o n g ro up ${Acti o nG ro up}
was attached to R o l e
${R o l eName} by ${UserName}
Fai l ed to attach Acti o n
g ro up ${Acti o nG ro up} to R o l e
${R o l eName} (User:
${UserName})
Acti o n g ro up ${Acti o nG ro up}
was d etached fro m R o l e
${R o l eName} by ${UserName}
Fai l ed to attach Acti o n
g ro up ${Acti o nG ro up} to R o l e
${R o l eName} by ${UserName}
R o l e ${R o l eName} was ad d ed
by ${UserName}
Fai l ed to ad d ro l e
${R o l eName}
User/G ro up ${SubjectName} was
g ranted permi ssi o n fo r R o l e
${R o l eName} o n
${Vd cO bjectT ype} by
${UserName}.
User ${UserName} fai l ed to
g rant permi ssi o n fo r R o l e
${R o l eName} o n
${Vd cO bjectT ype} to
User/G ro up ${SubjectName}.
User/G ro up ${SubjectName}
R o l e ${R o l eName} permi ssi o n
was remo ved fro m
${Vd cO bjectT ype} by
${UserName}
User ${UserName} fai l ed to
remo ve permi ssi o n fo r R o l e
${R o l eName} fro m
${Vd cO bjectT ype} to
User/G ro up ${SubjectName}
P ro fi l e created fo r
${UserName}
Fai l ed to create pro fi l e fo r
${UserName}
Upd ated pro fi l e fo r
${UserName}
Fai l ed to upd ate pro fi l e fo r
${UserName}
R emo ved pro fi l e fo r
${UserName}
Fai l ed to remo ve pro fi l e fo r
${UserName}
86 4
86 5
86 6
872
873
874
875
Info
Erro r
Info
Info
Info
265
REST API ガイド
コード
名前
重大度
メッセージ
876
HO ST _C ER T IFIC AT IO N_I
S_INVALID
Erro r
Ho st ${Vd sName}
certi fi cati o n i s i nval i d .
T he certi fi cati o n has no
peer certi fi cates.
877
HO ST _C ER T IFIC AT IO N_H
AS_EXP IR ED
ENG INE_C ER T IFIC AT IO N
_IS_ABO UT _T O _EXP IR E_
ALER T
Info
879
HO ST _C ER T IFIC AT IO N_I
S_ABO UT _T O _EXP IR E_AL
ER T
Info
880
HO ST _C ER T IFIC AT IO N_E
NR O LLMENT _ST AR T ED
No rmal
881
HO ST _C ER T IFIC AT IO N_E
NR O LLMENT _FINISHED
No rmal
882
HO ST _C ER T IFIC AT IO N_E
NR O LLMENT _FAILED
Erro r
883
ENG INE_C A_C ER T IFIC AT
IO N_IS_ABO UT _T O _EXP I
R E_ALER T
AD _C O MP UT ER _AC C O UNT
_SUC C EED ED
AD _C O MP UT ER _AC C O UNT
_FAILED
USER _FO R C E_R EMO VE_ST
O R AG E_P O O L
Info
9 19
USER _FO R C E_R EMO VE_ST
O R AG E_P O O L_FAILED
Erro r
9 20
NET WO R K_AT T AC H_NET WO
R K_T O _VD S
Info
9 21
NET WO R K_AT T AC H_NET WO
R K_T O _VD S_FAILED
Erro r
9 22
NET WO R K_D ET AC H_NET WO
R K_FR O M_VD S
Info
878
900
901
9 18
266
Info
Info
Eng i ne' s certi fi cati o n i s
abo ut to expi re at
${Expi rati o nD ate}. P l ease
renew the eng i ne' s
certi fi cati o n.
Ho st ${Vd sName}
certi fi cati o n i s abo ut to
expi re at ${Expi rati o nD ate}.
P l ease renew the ho st' s
certi fi cati o n.
Enro l l i ng certi fi cate fo r
ho st ${Vd sName} was started
(User: ${UserName}).
Enro l l i ng certi fi cate fo r
ho st ${Vd sName} was
co mpl eted successful l y
(User: ${UserName}).
Fai l ed to enro l l certi fi cate
fo r ho st ${Vd sName} (User:
${UserName}).
Eng i ne' s C A certi fi cati o n i s
abo ut to expi re at
${Expi rati o nD ate}.
Acco unt creati o n successful .
Erro r
Acco unt creati o n fai l ed .
Info
D ata C enter
${Sto rag eP o o l Name} was
fo rci bl y remo ved by
${UserName}
Fai l ed to fo rci bl y remo ve
D ata C enter
${Sto rag eP o o l Name}. (User:
${UserName})
Attach netwo rk:
${Netwo rkName} to Ho st:
${Vd sName} by ${UserName}.
Fai l ed to attach netwo rk:
${Netwo rkName} to Ho st:
${Vd sName} (User:
${UserName}).
D etach netwo rk:
${Netwo rkName} fro m Ho st:
${Vd sName} by ${UserName}.
⁠付録C イベントコード
コード
名前
重大度
メッセージ
9 23
NET WO R K_D ET AC H_NET WO
R K_FR O M_VD S_FAILED
Erro r
9 24
NET WO R K_AD D _BO ND
Info
9 25
NET WO R K_AD D _BO ND _FAI
LED
Erro r
9 26
NET WO R K_R EMO VE_BO ND
Info
9 27
NET WO R K_R EMO VE_BO ND _
FAILED
Erro r
9 28
NET WO R K_VD S_NET WO R K_
MAT C H_C LUST ER
NET WO R K_VD S_NET WO R K_
NO T _MAT C H_C LUST ER
Info
9 30
NET WO R K_R EMO VE_VM_IN
T ER FAC E
Info
9 31
NET WO R K_R EMO VE_VM_IN
T ER FAC E_FAILED
Erro r
9 32
NET WO R K_AD D _VM_INT ER
FAC E
Info
9 33
NET WO R K_AD D _VM_INT ER
FAC E_FAILED
Erro r
9 34
NET WO R K_UP D AT E_VM_IN
T ER FAC E
Info
9 35
NET WO R K_UP D AT E_VM_IN
T ER FAC E_FAILED
Erro r
Fai l ed to d etach netwo rk:
${Netwo rkName} fro m Ho st:
${Vd sName} (User:
${UserName}).
Ad d bo nd : ${Bo nd Name} wi th
i nterfaces: ${Interfaces} fo r
Ho st: ${Vd sName} by
${UserName}.
Fai l ed to ad d bo nd :
${Bo nd Name} wi th i nterfaces:
${Interfaces} fo r Ho st:
${Vd sName}
(User: ${UserName}).
R emo ve bo nd : ${Bo nd Name} fo r
Ho st: ${Vd sName}
(User: ${UserName}).
Fai l ed to remo ve bo nd :
${Bo nd Name} fo r Ho st:
${Vd sName}
(User: ${UserName}).
Vd s ${Vd sName} netwo rk match
to cl uster ${Vd sG ro upName}
Vd s ${Vd sName} netwo rk d o es
no t match to cl uster
${Vd sG ro upName}
Interface ${InterfaceName}
(${InterfaceT ype}) was
remo ved fro m VM ${VmName}.
(User: ${UserName})
Fai l ed to remo ve Interface
${InterfaceName}
(${InterfaceT ype}) fro m VM
${VmName}. (User:
${UserName})
Interface ${InterfaceName}
(${InterfaceT ype}) was ad d ed
to VM ${VmName}. (User:
${UserName})
Fai l ed to ad d Interface
${InterfaceName}
(${InterfaceT ype}) to VM
${VmName}. (User:
${UserName})
Interface ${InterfaceName}
(${InterfaceT ype}) was
upd ated fo r VM ${VmName}.
${Li nkState} (User:
${UserName})
Fai l ed to upd ate Interface
${InterfaceName}
(${InterfaceT ype}) fo r VM
${VmName}. (User:
${UserName})
9 29
Erro r
267
REST API ガイド
コード
名前
重大度
メッセージ
9 36
NET WO R K_AD D _T EMP LAT E
_INT ER FAC E
Info
9 37
NET WO R K_AD D _T EMP LAT E
_INT ER FAC E_FAILED
Erro r
9 38
NET WO R K_R EMO VE_T EMP L
AT E_INT ER FAC E
Info
9 39
NET WO R K_R EMO VE_T EMP L
AT E_INT ER FAC E_FAILED
Erro r
940
NET WO R K_UP D AT E_T EMP L
AT E_INT ER FAC E
Info
941
NET WO R K_UP D AT E_T EMP L
AT E_INT ER FAC E_FAILED
Erro r
942
NET WO R K_AD D _NET WO R K
Info
943
NET WO R K_AD D _NET WO R K_
FAILED
Erro r
944
NET WO R K_R EMO VE_NET WO
RK
Info
945
NET WO R K_R EMO VE_NET WO
R K_FAILED
Erro r
946
NET WO R K_AT T AC H_NET WO
R K_T O _VD S_G R O UP
Info
947
NET WO R K_AT T AC H_NET WO
R K_T O _VD S_G R O UP _FAIL
ED
NET WO R K_D ET AC H_NET WO
R K_T O _VD S_G R O UP
Erro r
Interface ${InterfaceName}
(${InterfaceT ype}) was ad d ed
to T empl ate
${VmT empl ateName}. (User:
${UserName})
Fai l ed to ad d Interface
${InterfaceName}
(${InterfaceT ype}) to
T empl ate ${VmT empl ateName}.
(User: ${UserName})
Interface ${InterfaceName}
(${InterfaceT ype}) was
remo ved fro m T empl ate
${VmT empl ateName}. (User:
${UserName})
Fai l ed to remo ve Interface
${InterfaceName}
(${InterfaceT ype}) fro m
T empl ate ${VmT empl ateName}.
(User: ${UserName})
Interface ${InterfaceName}
(${InterfaceT ype}) was
upd ated fo r T empl ate
${VmT empl ateName}. (User:
${UserName})
Fai l ed to upd ate Interface
${InterfaceName}
(${InterfaceT ype}) fo r
T empl ate ${VmT empl ateName}.
(User: ${UserName})
Netwo rk ${Netwo rkName} was
ad d ed to D ata C enter:
${Sto rag eP o o l Name}
Fai l ed to ad d Netwo rk
${Netwo rkName} to D ata
C enter: ${Sto rag eP o o l Name}
Netwo rk ${Netwo rkName} was
remo ved fro m D ata C enter:
${Sto rag eP o o l Name}
Fai l ed to remo ve Netwo rk
${Netwo rkName} fro m D ata
C enter: ${Sto rag eP o o l Name}
Netwo rk ${Netwo rkName}
attached to C l uster
${Vd sG ro upName}
Fai l ed to attach Netwo rk
${Netwo rkName} to C l uster
${Vd sG ro upName}
Netwo rk ${Netwo rkName}
d etached fro m C l uster
${Vd sG ro upName}
948
268
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
949
NET WO R K_D ET AC H_NET WO
R K_T O _VD S_G R O UP _FAIL
ED
USER _AD D _ST O R AG E_P O
OL
Erro r
9 51
USER _AD D _ST O R AG E_P O
O L_FAILED
Erro r
9 52
USER _UP D AT E_ST O R AG E_
POOL
Info
9 53
USER _UP D AT E_ST O R AG E_
P O O L_FAILED
Erro r
9 54
USER _R EMO VE_ST O R AG E_
POOL
Info
9 55
USER _R EMO VE_ST O R AG E_
P O O L_FAILED
Erro r
9 56
USER _AD D _ST O R AG E_D O M Info
AIN
9 57
USER _AD D _ST O R AG E_D O M Erro r
AIN_FAILED
9 58
USER _UP D AT E_ST O R AG E_
D O MAIN
Info
9 59
USER _UP D AT E_ST O R AG E_
D O MAIN_FAILED
Erro r
960
USER _R EMO VE_ST O R AG E_
D O MAIN
Info
961
USER _R EMO VE_ST O R AG E_
D O MAIN_FAILED
Erro r
962
USER _AT T AC H_ST O R AG E_
D O MAIN_T O _P O O L
Info
963
USER _AT T AC H_ST O R AG E_
D O MAIN_T O _P O O L_FAILE
D
Erro r
Fai l ed to d etach Netwo rk
${Netwo rkName} fro m C l uster
${Vd sG ro upName}
D ata C enter
${Sto rag eP o o l Name},
C o mpati bi l i ty Versi o n
${C o mpati bi l i tyVersi o n} and
Q uo ta T ype
${Q uo taEnfo rcementT ype} was
ad d ed by ${UserName}
Fai l ed to ad d D ata C enter
${Sto rag eP o o l Name}. (User:
${UserName})
D ata C enter
${Sto rag eP o o l Name} was
upd ated by ${UserName}
Fai l ed to upd ate D ata C enter
${Sto rag eP o o l Name}. (User:
${UserName})
D ata C enter
${Sto rag eP o o l Name} was
remo ved by ${UserName}
Fai l ed to remo ve D ata C enter
${Sto rag eP o o l Name}. (User:
${UserName})
Sto rag e D o mai n
${Sto rag eD o mai nName} was
ad d ed by ${UserName}
Fai l ed to ad d Sto rag e
D o mai n ${Sto rag eD o mai nName}.
(User: ${UserName})
Sto rag e D o mai n
${Sto rag eD o mai nName} was
upd ated by ${UserName}
Fai l ed to upd ate Sto rag e
D o mai n ${Sto rag eD o mai nName}.
(User: ${UserName})
Sto rag e D o mai n
${Sto rag eD o mai nName} was
remo ved by ${UserName}
Fai l ed to remo ve Sto rag e
D o mai n ${Sto rag eD o mai nName}.
(User: ${UserName})
Sto rag e D o mai n
${Sto rag eD o mai nName} was
attached to D ata C enter
${Sto rag eP o o l Name} by
${UserName}
Fai l ed to attach Sto rag e
D o mai n ${Sto rag eD o mai nName}
to D ata C enter
${Sto rag eP o o l Name}. (User:
${UserName})
9 50
Info
269
REST API ガイド
コード
名前
重大度
メッセージ
964
USER _D ET AC H_ST O R AG E_
D O MAIN_FR O M_P O O L
Info
965
USER _D ET AC H_ST O R AG E_
D O MAIN_FR O M_P O O L_FAI
LED
Erro r
966
USER _AC T IVAT ED _ST O R A
G E_D O MAIN
Info
967
USER _AC T IVAT E_ST O R AG
E_D O MAIN_FAILED
Erro r
968
USER _D EAC T IVAT ED _ST O
R AG E_D O MAIN
Info
969
USER _D EAC T IVAT E_ST O R
AG E_D O MAIN_FAILED
Erro r
9 70
SY ST EM_D EAC T IVAT ED _S
T O R AG E_D O MAIN
Warni ng
9 71
SY ST EM_D EAC T IVAT E_ST
O R AG E_D O MAIN_FAILED
Erro r
9 72
USER _EXT END ED _ST O R AG
E_D O MAIN
Info
9 73
USER _EXT END ED _ST O R AG
E_D O MAIN_FAILED
Erro r
9 74
USER _R EMO VE_VG
Info
9 75
USER _R EMO VE_VG _FAILE
D
Erro r
Sto rag e D o mai n
${Sto rag eD o mai nName} was
d etached fro m D ata C enter
${Sto rag eP o o l Name} by
${UserName}
Fai l ed to d etach Sto rag e
D o mai n ${Sto rag eD o mai nName}
to D ata C enter
${Sto rag eP o o l Name}. (User:
${UserName})
Sto rag e D o mai n
${Sto rag eD o mai nName} (D ata
C enter ${Sto rag eP o o l Name})
was acti vated by ${UserName}
Fai l ed to acti vate Sto rag e
D o mai n ${Sto rag eD o mai nName}
(D ata C enter
${Sto rag eP o o l Name}) by
${UserName}
Sto rag e D o mai n
${Sto rag eD o mai nName} (D ata
C enter ${Sto rag eP o o l Name})
was d eacti vated and has
mo ved to ' P repari ng fo r
mai ntenance' unti l i t wi l l
no l o ng er be accessed by any
Ho st o f the D ata C enter.
Fai l ed to d eacti vate Sto rag e
D o mai n ${Sto rag eD o mai nName}
(D ata C enter
${Sto rag eP o o l Name}).
Sto rag e D o mai n
${Sto rag eD o mai nName} (D ata
C enter ${Sto rag eP o o l Name})
was d eacti vated by system
because i t' s no t vi si bl e by
any o f the ho sts.
Fai l ed to d eacti vate Sto rag e
D o mai n ${Sto rag eD o mai nName}
(D ata C enter
${Sto rag eP o o l Name}).
Sto rag e ${Sto rag eD o mai nName}
has been extend ed by
${UserName}. P l ease wai t fo r
refresh.
Fai l ed to extend Sto rag e
D o mai n ${Sto rag eD o mai nName}.
(User: ${UserName})
Vo l ume g ro up ${Vg Id } was
remo ved by ${UserName}.
Fai l ed to remo ve Vo l ume
g ro up ${Vg Id }. (User:
UserName)
270
⁠付録C イベントコード
コード
名前
重大度
メッセージ
9 76
USER _AC T IVAT E_ST O R AG
E_P O O L
Info
9 77
USER _AC T IVAT E_ST O R AG
E_P O O L_FAILED
Erro r
9 78
SY ST EM_FAILED _C HANG E Erro r
_ST O R AG E_P O O L_ST AT US
SY ST EM_C HANG E_ST O R AG Erro r
E_P O O L_ST AT US_NO _HO S
T _FO R _SP M
D ata C enter
${Sto rag eP o o l Name} was
acti vated . (User:
${UserName})
Fai l ed to acti vate D ata
C enter ${Sto rag eP o o l Name}.
(User: ${UserName})
Fai l ed to chang e D ata C enter
${Sto rag eP o o l Name} status.
Fenci ng fai l ed o n Sto rag e
P o o l Manag er ${Vd sName} fo r
D ata C enter
${Sto rag eP o o l Name}. Setti ng
status to No n-O perati o nal .
Inval i d status o n D ata
C enter ${Sto rag eP o o l Name}.
Setti ng status to No n
R espo nsi ve.
Sto rag e D o mai n
${Sto rag eD o mai nName} was
fo rci bl y remo ved by
${UserName}
Fai l ed to fo rci bl y remo ve
Sto rag e D o mai n
${Sto rag eD o mai nName}. (User:
${UserName})
No val i d D ata Sto rag e
D o mai ns are avai l abl e i n
D ata C enter
${Sto rag eP o o l Name} (pl ease
check yo ur sto rag e
i nfrastructure).
R eco nstruct Master D o mai n
fo r D ata C enter
${Sto rag eP o o l Name}
co mpl eted .
Fai l ed to R eco nstruct Master
D o mai n fo r D ata C enter
${Sto rag eP o o l Name}.
D ata C enter i s bei ng
i ni ti al i zed , pl ease wai t fo r
i ni ti al i zati o n to co mpl ete.
9 79
9 80
SY ST EM_C HANG E_ST O R AG
E_P O O L_ST AT US_P R O BLE
MAT IC
Warni ng
9 81
USER _FO R C E_R EMO VE_ST
O R AG E_D O MAIN
Info
9 82
USER _FO R C E_R EMO VE_ST
O R AG E_D O MAIN_FAILED
Erro r
9 83
R EC O NST R UC T _MAST ER _F Warni ng
AILED _NO _MAST ER
9 84
R EC O NST R UC T _MAST ER _
D O NE
9 85
R EC O NST R UC T _MAST ER _F Erro r
AILED
9 86
SY ST EM_C HANG E_ST O R AG
E_P O O L_ST AT US_P R O BLE
MAT IC _SEAR C HING _NEW_
SP M
SY ST EM_C HANG E_ST O R AG
E_P O O L_ST AT US_P R O BLE
MAT IC _WIT H_ER R O R
Warni ng
USER _C O NNEC T _HO ST S_T
O _LUN_FAILED
Erro r
9 87
9 88
Info
Warni ng
Inval i d status o n D ata
C enter ${Sto rag eP o o l Name}.
Setti ng D ata C enter status to
No n R espo nsi ve (O n ho st
${Vd sName}, Erro r: ${Erro r}).
Fai l ed to co nnect Ho st
${Vd sName} to d evi ce. (User:
${UserName})
271
REST API ガイド
コード
名前
重大度
メッセージ
9 89
SY ST EM_C HANG E_ST O R AG
E_P O O L_ST AT US_P R O BLE
MAT IC _FR O M_NO N_O P ER A
T IO NAL
SY ST EM_MAST ER _D O MAIN
_NO T _IN_SY NC
Info
T ry to reco ver D ata C enter
${Sto rag eP o o l Name}. Setti ng
status to No n R espo nsi ve.
Warni ng
991
R EC O VER Y _ST O R AG E_P O
OL
Info
992
R EC O VER Y _ST O R AG E_P O
O L_FAILED
Erro r
993
SY ST EM_C HANG E_ST O R AG
E_P O O L_ST AT US_R ESET _
IR S
Info
994
C O NNEC T _ST O R AG E_SER V Warni ng
ER S_FAILED
C O NNEC T _ST O R AG E_P O O Warni ng
L_FAILED
Sync Erro r o n Master D o mai n
between Ho st ${Vd sName} and
o Vi rt Eng i ne. D o mai n:
${Sto rag eD o mai nName} i s
marked as Master i n o Vi rt
Eng i ne d atabase but no t o n
the Sto rag e si d e. P l ease
co nsul t wi th Suppo rt o n ho w
to fi x thi s i ssue.
D ata C enter
${Sto rag eP o o l Name} was
reco vered by ${UserName}
Fai l ed to reco ver D ata
C enter ${Sto rag eP o o l Name}
(User: ${UserName})
D ata C enter
${Sto rag eP o o l Name} was
reset. Setti ng status to No n
R espo nsi ve (El ect new
Sto rag e P o o l Manag er).
Fai l ed to co nnect Ho st
${Vd sName} to Sto rag e Servers
Fai l ed to co nnect Ho st
${Vd sName} to Sto rag e P o o l
${Sto rag eP o o l Name}
T he erro r messag e fo r
co nnecti o n ${C o nnecti o n}
returned by VD SM was:
${Erro rMessag e}
R efresh i mag e l i st fai l ed
fo r d o mai n(s):
${i mag eD o mai ns}. P l ease
check d o mai n acti vi ty.
R efresh i mag e l i st succeed ed
fo r d o mai n(s):
${i mag eD o mai ns}
T he system has reached the
80 % watermark o n the VG
metad ata area si ze o n
${Sto rag eD o mai nName}. \nT hi s
i s d ue to a hi g h number o f
Vd i sks o r l arg e Vd i sks si ze
al l o cated o n thi s speci fi c
VG .
990
995
996
ST O R AG E_D O MAIN_ER R O
R
997
R EFR ESH_R EP O SIT O R Y _I Erro r
MAG E_LIST _FAILED
998
R EFR ESH_R EP O SIT O R Y _I Info
MAG E_LIST _SUC C EED ED
999
ST O R AG E_ALER T _VG _MET
AD AT A_C R IT IC ALLY _FUL
L
272
Erro r
Erro r
⁠付録C イベントコード
コード
名前
重大度
メッセージ
10 0 0
ST O R AG E_ALER T _SMALL_
VG _MET AD AT A
Warni ng
10 0 1
USER _R UN_VM_FAILUR E_
ST AT ELESS_SNAP SHO T _L
EFT
Erro r
10 0 2
USER _AT T AC H_ST O R AG E_
D O MAINS_T O _P O O L
Info
10 0 3
USER _AT T AC H_ST O R AG E_
D O MAINS_T O _P O O L_FAIL
ED
Erro r
10 0 4
ST O R AG E_D O MAIN_T ASKS
_ER R O R
Warni ng
10 0 5
UP D AT E_O VF_FO R _ST O R A Warni ng
G E_P O O L_FAILED
10 0 6
UP G R AD E_ST O R AG E_P O O
L_ENC O UNT ER ED _P R O BLE
MS
10 0 7
R EFR ESH_R EP O SIT O R Y _I Warni ng
MAG E_LIST _INC O MP LET E
10 0 8
NUNBER _O F_LVS_O N_ST O
R AG E_D O MAIN_EXC EED ED
_T HR ESHO LD
10 10
R ELO AD _C O NFIG UR AT IO N Info
S_SUC C ESS
R ELO AD _C O NFIG UR AT IO N Erro r
S_FAILUR E
NET WO R K_AC T IVAT E_VM_ Info
INT ER FAC E_SUC C ESS
T he al l o cated VG metad ata
area si ze i s smal l er than
50 MB o n
${Sto rag eD o mai nName},\nwhi ch
mi g ht l i mi t i ts capaci ty
(the number o f Vd i sks and /o r
thei r si ze).
Fai l ed to start VM ${VmName},
because exi st snapsho t fo r
statel ess state. Snapsho t
wi l l be d el eted .
Sto rag e D o mai ns were
attached to D ata C enter
${Sto rag eP o o l Name} by
${UserName}
Fai l ed to attach Sto rag e
D o mai ns to D ata C enter
${Sto rag eP o o l Name}. (User:
${UserName})
Sto rag e D o mai n
${Sto rag eD o mai nName} i s d o wn
whi l e there are tasks runni ng
o n i t. T hese tasks may fai l .
Fai l ed to upd ate
VMs/T empl ates O VF d ata i n
D ata C enter
${Sto rag eP o o l Name}.
D ata C enter
${Sto rag eP o o l Name} has
enco untered pro bl ems d uri ng
upg rad e pro cess.
R efresh i mag e l i st pro babl y
i nco mpl ete fo r d o mai n
${i mag eD o mai n}, o nl y
${i mag eLi stSi ze} i mag es
d i sco vered .
T he number o f LVs o n the
d o mai n ${sto rag eD o mai nName}
exceed ed ${maxNumO fLVs}, yo u
are appro achi ng the l i mi t
where perfo rmance may
d eg rad e.
System C o nfi g urati o ns
rel o ad ed successful l y.
System C o nfi g urati o ns fai l ed
to rel o ad .
Netwo rk Interface
${InterfaceName}
(${InterfaceT ype}) was
pl ug g ed to VM ${VmName}.
(User: ${UserName})
10 11
10 12
Warni ng
Warni ng
273
REST API ガイド
コード
名前
重大度
メッセージ
10 13
NET WO R K_AC T IVAT E_VM_
INT ER FAC E_FAILUR E
Erro r
10 14
NET WO R K_D EAC T IVAT E_V
M_INT ER FAC E_SUC C ESS
Info
10 15
NET WO R K_D EAC T IVAT E_V
M_INT ER FAC E_FAILUR E
Erro r
10 16
UP D AT E_FO R _O VF_ST O R E Warni ng
S_FAILED
10 17
R ET R IEVE_O VF_ST O R E_F
AILED
Warni ng
10 18
O VF_ST O R E_D O ES_NO T _E
XIST S
Warni ng
10 19
UP D AT E_D ESC R IP T IO N_F Erro r
O R _D ISK_FAILED
10 20
UP D AT E_D ESC R IP T IO N_F Warni ng
O R _D ISK_SKIP P ED _SINC
E_ST O R AG E_D O MAIN_NO T
_AC T IVE
10 21
R ET R IEVE_UNR EG IST ER E
D _ENT IT IES_NO T _SUP P O
R T ED _IN_D C _VER SIO N
Fai l ed to pl ug Netwo rk
Interface ${InterfaceName}
(${InterfaceT ype}) to VM
${VmName}. (User:
${UserName})
Netwo rk Interface
${InterfaceName}
(${InterfaceT ype}) was
unpl ug g ed fro m VM ${VmName}.
(User: ${UserName})
Fai l ed to unpl ug Netwo rk
Interface ${InterfaceName}
(${InterfaceT ype}) fro m VM
${VmName}. (User:
${UserName})
Fai l ed to upd ate O VF d i sks
${D i sksId s}, O VF d ata i sn' t
upd ated o n tho se O VF sto res
(D ata C enter
${D ataC enterName}, Sto rag e
D o mai n
${Sto rag eD o mai nName}).
Fai l ed to retri eve VMs and
T empl ates fro m the O VF d i sk
o f Sto rag e D o mai n
${Sto rag eD o mai nName}.
T hi s D ata center
co mpati bi l i ty versi o n d o es
no t suppo rt i mpo rti ng a d ata
d o mai n wi th i ts enti ti es
(VMs and T empl ates). T he
i mpo rted d o mai n wi l l be
i mpo rted wi tho ut them.
Fai l ed to upd ate the meta
d ata d escri pti o n o f d i sk
${D i skName} (D ata C enter
${D ataC enterName}, Sto rag e
D o mai n
${Sto rag eD o mai nName}).
No t upd ati ng the metad ata o f
D i sk ${D i skName} (D ata
C enter ${D ataC enterName}.
Si nce the Sto rag e D o mai n
${Sto rag eD o mai nName} i s no t
i n acti ve.
Ski ppi ng retri eval attempt
o f VMs and T empl ates fro m
the O VF_ST O R E d i sk o f
Sto rag e D o mai n
${Sto rag eD o mai nName} si nce
i t i s no t suppo rted by the
D ata C enter versi o n.
274
Warni ng
⁠付録C イベントコード
コード
名前
重大度
メッセージ
10 22
USER _R EFR ESH_LUN_ST O
R AG E_D O MAIN
USER _R EFR ESH_LUN_ST O
R AG E_D O MAIN_FAILED
USER _R EFR ESH_LUN_ST O
R AG E_D IFFER ENT _SIZE_
D O MAIN_FAILED
VM_P AUSED
Info
R esi ze LUNs o perati o n
succeed ed .
Fai l ed to resi ze LUNs.
10 26
FAILED _T O _ST O R E_ENT I
R E_D ISK_FIELD _IN_D IS
K_D ESC R IP T IO N_MET AD A
TA
Warni ng
10 27
FAILED _T O _ST O R E_ENT I
R E_D ISK_FIELD _AND _R E
ST _O F_FIELD S_IN_D ISK
_D ESC R IP T IO N_MET AD AT
A
Warni ng
10 28
FAILED _T O _ST O R E_D ISK
_FIELD S_IN_D ISK_D ESC
R IP T IO N_MET AD AT A
Warni ng
10 29
ST O R AG E_D O MAIN_MO VED
_T O _MAINT ENANC E
Info
10 30
USER _D EAC T IVAT ED _LAS Info
T _MAST ER _ST O R AG E_D O M
AIN
10 9 8
NET WO R K_UP D AT E_D ISP L
AY _FO R _HO ST _WIT H_AC T
IVE_VM
10 23
10 24
10 25
Erro r
Erro r
Info
Warni ng
Fai l ed to resi ze LUNs. \n No t
al l the ho sts are seei ng the
same LUN si ze.
VM ${VmName} has been
paused .
Fai l ed to sto re fi el d
${D i skFi el d Name} as a part
o f ${D i skAl i as}' s
d escri pti o n metad ata d ue to
sto rag e space l i mi tati o ns.
T he fi el d ${D i skFi el d Name}
wi l l be truncated .
Fai l ed to sto re fi el d
${D i skFi el d Name} as a part
o f ${D i skAl i as}' s
d escri pti o n metad ata d ue to
sto rag e space l i mi tati o ns.
T he val ue wi l l be truncated
and the fo l l o wi ng fi el d s
wi l l no t be sto red at al l :
${D i skFi el d sNames}.
Fai l ed to sto re the
fo l l o wi ng fi el d s i n the
d escri pti o n metad ata o f d i sk
${D i skAl i as} d ue to sto rag e
space l i mi tati o ns:
${D i skFi el d sNames}.
Sto rag e D o mai n
${Sto rag eD o mai nName} (D ata
C enter ${Sto rag eP o o l Name})
successful l y mo ved to
Mai ntenance as i t' s no
l o ng er accessed by any Ho st
o f the D ata C enter.
Sto rag e D o mai n
${Sto rag eD o mai nName} (D ata
C enter ${Sto rag eP o o l Name})
was d eacti vated .
D i spl ay Netwo rk was upd ated
o n Ho st ${Vd sName} wi th
acti ve VMs attached . T he
chang e wi l l be appl i ed to
tho se VMs after thei r next
rebo o t. R unni ng VMs mi g ht
l o o se d i spl ay co nnecti vi ty
unti l then.
275
REST API ガイド
コード
名前
重大度
メッセージ
10 9 9
NET WO R K_UP D AT E_D ISP L
AY _FO R _C LUST ER _WIT H_
AC T IVE_VM
Warni ng
110 0
NET WO R K_UP D AT E_D ISP L
AY _T O _VD S_G R O UP
Info
110 1
NET WO R K_UP D AT E_D ISP L
AY _T O _VD S_G R O UP _FAIL
ED
Erro r
110 2
NET WO R K_UP D AT E_NET WO
R K_T O _VD S_INT ER FAC E
Info
110 3
NET WO R K_UP D AT E_NET WO
R K_T O _VD S_INT ER FAC E_
FAILED
Erro r
110 4
NET WO R K_C O MMINT _NET W
O R K_C HANG ES
NET WO R K_C O MMINT _NET W
O R K_C HANG ES_FAILED
NET WO R K_HO ST _USING _W
R O NG _C LUSER _VLAN
Info
110 7
NET WO R K_HO ST _MISSING
_C LUSER _VLAN
Warni ng
D i spl ay Netwo rk
(${Netwo rkName}) was upd ated
fo r C l uster ${Vd sG ro upName}
wi th acti ve VMs attached .
T he chang e wi l l be appl i ed
to tho se VMs after thei r next
rebo o t.
Upd ate D i spl ay Netwo rk
(${Netwo rkName}) fo r C l uster
${Vd sG ro upName}. (User:
${UserName})
Fai l ed to upd ate D i spl ay
Netwo rk (${Netwo rkName}) fo r
C l uster ${Vd sG ro upName}.
(User: ${UserName})
Upd ate Netwo rk ${Netwo rkName}
i n Ho st ${Vd sName}. (User:
${UserName})
Fai l ed to upd ate Netwo rk
${Netwo rkName} i n Ho st
${Vd sName}. (User:
${UserName})
Netwo rk chang es were saved
o n ho st ${Vd sName}
Fai l ed to co mmi t netwo rk
chang es o n ${Vd sName}
${Vd sName} i s havi ng wro ng
vl an i d : ${Vl anId Ho st},
expected vl an i d :
${Vl anId C l uster}
${Vd sName} i s mi ssi ng vl an
i d : ${Vl anId C l uster} that i s
expected by the cl uster
110 8
VD S_NET WO R K_MT U_D IFF
ER _FR O M_LO G IC AL_NET W
ORK
BR ID G ED _NET WO R K_O VER
_MULT IP LE_INT ER FAC ES
Info
1110
VD S_NET WO R KS_O UT _O F_
SY NC
Warni ng
1112
NET WO R K_UP D T AE_NET WO
R K_O N_C LUST ER
Info
1113
NET WO R K_UP D T AE_NET WO
R K_O N_C LUST ER _FAILED
Erro r
110 5
110 6
110 9
276
Erro r
Warni ng
Warni ng
Bri d g ed netwo rk
${Netwo rkName} i s attached to
mul ti pl e i nterfaces:
${Interfaces} o n Ho st
${Vd sName}.
Ho st ${Vd sName}' s fo l l o wi ng
netwo rk(s) are no t
synchro ni zed wi th thei r
Lo g i cal Netwo rk
co nfi g urati o n: ${Netwo rks}.
Netwo rk ${Netwo rkName} o n
C l uster ${Vd sG ro upName}
upd ated .
Fai l ed to upd ate Netwo rk
${Netwo rkName} o n C l uster
${Vd sG ro upName}.
⁠付録C イベントコード
コード
名前
重大度
メッセージ
1114
NET WO R K_UP D AT E_NET WO
RK
Info
1115
NET WO R K_UP D AT E_NET WO
R K_FAILED
Erro r
1116
NET WO R K_UP D AT E_VM_IN
T ER FAC E_LINK_UP
NET WO R K_UP D AT E_VM_IN
T ER FAC E_LINK_D O WN
INVALID _INT ER FAC E_FO
R _MANAG EMENT _NET WO R K
_C O NFIG UR AT IO N
Info
Netwo rk ${Netwo rkName} was
upd ated o n D ata C enter:
${Sto rag eP o o l Name}
Fai l ed to upd ate Netwo rk
${Netwo rkName} o n D ata
C enter: ${Sto rag eP o o l Name}
Li nk State i s UP .
Info
Li nk State i s D O WN.
Erro r
1119
VLAN_ID _MISMAT C H_FO R
_MANAG EMENT _NET WO R K_
C O NFIG UR AT IO N
Erro r
1120
SET UP _NET WO R K_FAILED
_FO R _MANAG EMENT _NET W
O R K_C O NFIG UR AT IO N
Erro r
1121
P ER SIST _NET WO R K_FAIL
ED _FO R _MANAG EMENT _NE
T WO R K
Warni ng
1122
AD D _VNIC _P R O FILE
Info
1123
AD D _VNIC _P R O FILE_FAI
LED
Erro r
Fai l ed to co nfi g ure
manag ement netwo rk o n ho st
${Vd sName}. Ho st ${Vd sName}
has an i nval i d i nterface
${InterfaceName} fo r the
manag ement netwo rk
co nfi g urati o n.
Fai l ed to co nfi g ure
manag ement netwo rk o n ho st
${Vd sName}. Ho st ${Vd sName}
has an i nterface
${InterfaceName} fo r the
manag ement netwo rk
co nfi g urati o n wi th VLAN-ID
(${Vl anId }), whi ch i s
d i fferent fro m d ata-center
d efi ni ti o n (${Mg mtVl anId }).
Fai l ed to co nfi g ure
manag ement netwo rk o n ho st
${Vd sName} d ue to setup
netwo rks fai l ure.
Fai l ed to acti vate ho st
${Vd sName} d ue to fai l ure i n
persi sti ng the manag ement
netwo rk co nfi g urati o n.
VM netwo rk i nterface pro fi l e
${Vni cP ro fi l eName} was ad d ed
to netwo rk ${Netwo rkName} i n
D ata C enter:
${D ataC enterName}. (User:
${UserName})
Fai l ed to ad d VM netwo rk
i nterface pro fi l e
${Vni cP ro fi l eName} to
netwo rk ${Netwo rkName} i n
D ata C enter:
${D ataC enterName} (User:
${UserName})
1117
1118
277
REST API ガイド
コード
名前
重大度
メッセージ
1124
UP D AT E_VNIC _P R O FILE
Info
1125
UP D AT E_VNIC _P R O FILE_
FAILED
Erro r
1126
R EMO VE_VNIC _P R O FILE
Info
1127
R EMO VE_VNIC _P R O FILE_
FAILED
Erro r
1128
NET WO R K_WIT HO UT _INT E
R FAC ES
Warni ng
1129
VNIC _P R O FILE_UNSUP P O
R T ED _FEAT UR ES
Warni ng
1131
R EMO VE_NET WO R K_BY _LA
BEL_FAILED
Erro r
1132
LABEL_NET WO R K
Info
1133
LABEL_NET WO R K_FAILED
Erro r
1134
UNLABEL_NET WO R K
Info
VM netwo rk i nterface pro fi l e
${Vni cP ro fi l eName} was
upd ated fo r netwo rk
${Netwo rkName} i n D ata
C enter: ${D ataC enterName}.
(User: ${UserName})
Fai l ed to upd ate VM netwo rk
i nterface pro fi l e
${Vni cP ro fi l eName} fo r
netwo rk ${Netwo rkName} i n
D ata C enter:
${D ataC enterName}. (User:
${UserName})
VM netwo rk i nterface pro fi l e
${Vni cP ro fi l eName} was
remo ved fro m netwo rk
${Netwo rkName} i n D ata
C enter: ${D ataC enterName}.
(User: ${UserName})
Fai l ed to remo ve VM netwo rk
i nterface pro fi l e
${Vni cP ro fi l eName} fro m
netwo rk ${Netwo rkName} i n
D ata C enter:
${D ataC enterName}. (User:
${UserName})
Netwo rk ${Netwo rkName} i s no t
attached to any i nterface o n
ho st ${Vd sName}.
VM ${VmName} has netwo rk
i nterface ${Ni cName} whi ch
i s usi ng pro fi l e
${Vni cP ro fi l e} wi th
unsuppo rted feature(s)
' ${Unsuppo rted Features}' by
VM cl uster ${Vd sG ro upName}
(versi o n
${C o mpati bi l i tyVersi o n}).
Netwo rk ${Netwo rk} canno t be
remo ved fro m the fo l l o wi ng
ho sts: ${Ho stNames} i n d atacenter ${Sto rag eP o o l Name}.
Netwo rk ${Netwo rkName} was
l abel ed ${Label } i n d atacenter ${Sto rag eP o o l Name}.
Fai l ed to l abel netwo rk
${Netwo rkName} wi th l abel
${Label } i n d ata-center
${Sto rag eP o o l Name}.
Netwo rk ${Netwo rkName} was
unl abel ed i n d ata-center
${Sto rag eP o o l Name}.
278
⁠付録C イベントコード
コード
名前
重大度
メッセージ
1135
UNLABEL_NET WO R K_FAIL
ED
Erro r
1136
LABEL_NIC
Info
1137
LABEL_NIC _FAILED
Erro r
1138
UNLABEL_NIC
Info
1139
UNLABEL_NIC _FAILED
Erro r
114 0
SUBNET _R EMO VED
Info
114 1
SUBNET _R EMO VAL_FAILE
D
Erro r
114 2
SUBNET _AD D ED
Info
114 3
SUBNET _AD D IT IO N_FAIL
ED
Erro r
114 4
C O NFIG UR E_NET WO R K_BY
_LABELS_WHEN_C HANG IN
G _C LUST ER _FAILED
P ER SIST _NET WO R K_O N_H
O ST
Erro r
114 6
P ER SIST _NET WO R K_O N_H
O ST _FINISHED
Info
114 7
P ER SIST _NET WO R K_O N_H
O ST _FAILED
Erro r
Fai l ed to unl abel netwo rk
${Netwo rkName} i n d ata-center
${Sto rag eP o o l Name}.
Netwo rk i nterface card
${Ni cName} was l abel ed
${Label } o n ho st ${Vd sName}.
Fai l ed to l abel netwo rk
i nterface card ${Ni cName}
wi th l abel ${Label } o n ho st
${Vd sName}.
Label ${Label } was remo ved
fro m netwo rk i nterface card
${Ni cName} o n ho st
${Vd sName}.
Fai l ed to remo ve l abel
${Label } fro m netwo rk
i nterface card ${Ni cName} o n
ho st ${Vd sName}.
Subnet ${SubnetName} was
remo ved fro m pro vi d er
${P ro vi d erName}. (User:
${UserName})
Fai l ed to remo ve subnet
${SubnetName} fro m pro vi d er
${P ro vi d erName}. (User:
${UserName})
Subnet ${SubnetName} was
ad d ed o n pro vi d er
${P ro vi d erName}. (User:
${UserName})
Fai l ed to ad d subnet
${SubnetName} o n pro vi d er
${P ro vi d erName}. (User:
${UserName})
Fai l ed to co nfi g ure netwo rks
o n ho st ${Vd sName} whi l e
chang i ng i ts cl uster.
(${Seq uence}/${T o tal }):
Appl yi ng chang es fo r
netwo rk(s) ${Netwo rkNames} o n
ho st ${Vd sName}. (User:
${UserName})
(${Seq uence}/${T o tal }):
Successful l y appl i ed chang es
fo r netwo rk(s)
${Netwo rkNames} o n ho st
${Vd sName}. (User:
${UserName})
(${Seq uence}/${T o tal }):
Fai l ed to appl y chang es fo r
netwo rk(s) ${Netwo rkNames} o n
ho st ${Vd sName}. (User:
${UserName})
114 5
Info
279
REST API ガイド
コード
名前
重大度
メッセージ
114 8
MULT I_UP D AT E_NET WO R K
_NO T _P O SSIBLE
Warni ng
114 9
R EMO VE_P O R T _FR O M_EXT
ER NAL_P R O VID ER _FAILE
D
Warni ng
1150
IMP O R T EXP O R T _EXP O R T
_VM
Info
1151
IMP O R T EXP O R T _EXP O R T
_VM_FAILED
Erro r
1152
IMP O R T EXP O R T _IMP O R T
_VM
Info
1153
IMP O R T EXP O R T _IMP O R T
_VM_FAILED
Erro r
1154
IMP O R T EXP O R T _R EMO VE
_T EMP LAT E
Info
1155
IMP O R T EXP O R T _R EMO VE
_T EMP LAT E_FAILED
Erro r
1156
IMP O R T EXP O R T _EXP O R T
_T EMP LAT E
Info
1157
IMP O R T EXP O R T _EXP O R T
_T EMP LAT E_FAILED
Erro r
1158
IMP O R T EXP O R T _IMP O R T
_T EMP LAT E
Info
1159
IMP O R T EXP O R T _IMP O R T
_T EMP LAT E_FAILED
Erro r
116 0
IMP O R T EXP O R T _R EMO VE
_VM
IMP O R T EXP O R T _R EMO VE
_VM_FAILED
Info
C anno t appl y netwo rk
${Netwo rkName} chang es to
ho sts o n unsuppo rted d ata
center ${Sto rag eP o o l Name}.
(User: ${UserName})
Fai l ed to remo ve vNIC
${Ni cName} fro m external
netwo rk pro vi d er
${P ro vi d erName}. T he vNIC
can be i d enti fi ed o n the
pro vi d er by d evi ce i d
${Ni cId }.
Vm ${VmName} was expo rted
successful l y to
${Sto rag eD o mai nName}
Fai l ed to expo rt Vm
${VmName} to
${Sto rag eD o mai nName}
Vm ${VmName} was i mpo rted
successful l y to D ata C enter
${Sto rag eP o o l Name}, C l uster
${Vd sG ro upName}
Fai l ed to i mpo rt Vm
${VmName} to D ata C enter
${Sto rag eP o o l Name}, C l uster
${Vd sG ro upName}
T empl ate ${VmT empl ateName}
was remo ved fro m
${Sto rag eD o mai nName}
Fai l ed to remo ve T empl ate
${VmT empl ateName} fro m
${Sto rag eD o mai nName}
T empl ate ${VmT empl ateName}
was expo rted successful l y to
${Sto rag eD o mai nName}
Fai l ed to expo rt T empl ate
${VmT empl ateName} to
${Sto rag eD o mai nName}
T empl ate ${VmT empl ateName}
was i mpo rted successful l y to
D ata C enter
${Sto rag eP o o l Name}, C l uster
${Vd sG ro upName}
Fai l ed to i mpo rt T empl ate
${VmT empl ateName} to D ata
C enter ${Sto rag eP o o l Name},
C l uster ${Vd sG ro upName}
Vm ${VmName} was remo ved
fro m ${Sto rag eD o mai nName}
Fai l ed to remo ve Vm
${VmName} remo ve fro m
${Sto rag eD o mai nName}
116 1
280
Erro r
⁠付録C イベントコード
コード
名前
重大度
メッセージ
116 2
IMP O R T EXP O R T _ST AR T I
NG _EXP O R T _VM
IMP O R T EXP O R T _ST AR T I
NG _IMP O R T _T EMP LAT E
Info
116 4
IMP O R T EXP O R T _ST AR T I
NG _EXP O R T _T EMP LAT E
Info
116 5
IMP O R T EXP O R T _ST AR T I
NG _IMP O R T _VM
Info
116 6
IMP O R T EXP O R T _ST AR T I
NG _R EMO VE_T EMP LAT E
Info
116 7
IMP O R T EXP O R T _ST AR T I
NG _R EMO VE_VM
Info
116 8
IMP O R T EXP O R T _FAILED _ Warni ng
T O _IMP O R T _VM
116 9
IMP O R T EXP O R T _FAILED _ Warni ng
T O _IMP O R T _T EMP LAT E
1170
IMP O R T EXP O R T _IMP O R T
_T EMP LAT E_INVALID _IN
T ER FAC ES
No rmal
1171
USER _AC C O UNT _P ASSWO R
D _EXP IR ED
Erro r
1172
AUT H_FAILED _INVALID _
C R ED ENT IALS
Erro r
1173
AUT H_FAILED _C LO C K_SK
EW_T O O _G R EAT
Erro r
Starti ng expo rt Vm ${VmName}
to ${Sto rag eD o mai nName}
Starti ng to i mpo rt T empl ate
${VmT empl ateName} to D ata
C enter ${Sto rag eP o o l Name},
C l uster ${Vd sG ro upName}
Starti ng to expo rt T empl ate
${VmT empl ateName} to
${Sto rag eD o mai nName}
Starti ng to i mpo rt Vm
${VmName} to D ata C enter
${Sto rag eP o o l Name}, C l uster
${Vd sG ro upName}
Starti ng to remo ve T empl ate
${VmT empl ateName} remo ve
${Sto rag eD o mai nName}
Starti ng to remo ve Vm
${VmName} remo ve fro m
${Sto rag eD o mai nName}
Fai l ed to read VM
' ${Impo rted VmName}' O VF, i t
may be co rrupted . Und erl yi ng
erro r messag e:
${Erro rMessag e}
Fai l ed to read T empl ate
' ${T empl ate}' O VF, i t may be
co rrupted . Und erl yi ng erro r
messag e: ${Erro rMessag e}
Whi l e i mpo rti ng T empl ate
${Enti tyName}, the Netwo rk/s
${Netwo rks} were fo und to be
No n-VM Netwo rks o r d o no t
exi st i n C l uster. Netwo rk
Name was no t set i n the
Interface/s ${Interfaces}.
User ${UserName} canno t
l o g i n, as the user acco unt
passwo rd has expi red . P l ease
co ntact the system
ad mi ni strato r.
User ${UserName} canno t
l o g i n, pl ease veri fy the
username and passwo rd .
User ${UserName} canno t
l o g i n, the eng i ne cl o ck i s
no t synchro ni zed wi th
d i recto ry servi ces. P l ease
co ntact the system
ad mi ni strato r.
116 3
Info
281
REST API ガイド
コード
名前
重大度
メッセージ
1174
AUT H_FAILED _NO _KD C S_
FO UND
Erro r
1175
AUT H_FAILED _D NS_ER R O
R
Erro r
1176
AUT H_FAILED _O T HER
Erro r
1177
AUT H_FAILED _D NS_C O MM
UNIC AT IO N_ER R O R
Erro r
1178
AUT H_FAILED _C O NNEC T I
O N_T IMED _O UT
Erro r
1179
AUT H_FAILED _WR O NG _R E
ALM
Erro r
1180
AUT H_FAILED _C O NNEC T I
O N_ER R O R
Erro r
1181
AUT H_FAILED _C ANNO T _F
IND _LD AP _SER VER _FO R _
D O MAIN
Erro r
1182
AUT H_FAILED _NO _USER _
INFO R MAT IO N_WAS_FO UN
D
Erro r
1183
AUT H_FAILED _C LIENT _N
O T _FO UND _IN_KER BER O S
_D AT ABASE
Erro r
1184
AUT H_FAILED _INT ER NAL
_KER BER O S_ER R O R
Erro r
User ${UserName} canno t
l o g i n, authenti cati o n
d o mai n canno t be fo und .
P l ease co ntact the system
ad mi ni strato r.
User ${UserName} canno t
l o g i n, there' s an erro r i n
D NS co nfi g urati o n. P l ease
co ntact the system
ad mi ni strato r.
User ${UserName} canno t
l o g i n, unkno wn kerbero s
erro r. P l ease co ntact the
system ad mi ni strato r.
User ${UserName} canno t
l o g i n, canno t l o o kup D NS
fo r SR V reco rd s. P l ease
co ntact the system
ad mi ni strato r.
User ${UserName} canno t
l o g i n, co nnecti o n to LD AP
server has ti med o ut. P l ease
co ntact the system
ad mi ni strato r.
User ${UserName} canno t
l o g i n, pl ease veri fy yo ur
d o mai n name.
User ${UserName} canno t
l o g i n, co nnecti o n refused o r
so me co nfi g urati o n pro bl ems
exi st. P o ssi bl e D NS erro r.
P l ease co ntact the system
ad mi ni strato r.
User ${UserName} canno t
l o g i n, canno t fi nd val i d
LD AP server fo r d o mai n.
P l ease co ntact the system
ad mi ni strato r.
User ${UserName} canno t
l o g i n, no user i nfo rmati o n
was fo und . P l ease co ntact
the system ad mi ni strato r.
User ${UserName} canno t
l o g i n, user was no t fo und i n
d o mai n. P l ease co ntact the
system ad mi ni strato r.
User ${UserName} canno t
l o g i n, an i nternal erro r has
o curred i n the Kerbero s
i mpl ementati o n o f the JVM.
P l ease co ntact the system
ad mi ni strato r.
282
⁠付録C イベントコード
コード
名前
重大度
メッセージ
1185
USER _AC C O UNT _EXP IR ED
Erro r
1186
IMP O R T EXP O R T _NO _P R O
XY _HO ST _AVAILABLE_IN
_D C
Erro r
1187
IMP O R T EXP O R T _HO ST _C
ANNO T _SER VE_AS_P R O XY
Erro r
1189
IMP O R T EXP O R T _IMP O R T
_VM_FAILED _UP D AT ING _
O VF
Erro r
119 0
USER _R EST O R E_FR O M_SN
AP SHO T _ST AR T
Info
119 1
VM_D ISK_ALR EAD Y _C HAN
G ED
Info
119 2
VM_D ISK_ALR EAD Y _EJEC
T ED
Info
119 3
IMP O R T EXP O R T _ST AR T I
NG _C O NVER T _VM
IMP O R T EXP O R T _C O NVER
T _FAILED
IMP O R T EXP O R T _C ANNO T
_G ET _O VF
Info
119 6
IMP O R T EXP O R T _INVALID
_O VF
Info
120 0
ENT IT Y _R ENAMED
Info
120 1
UP D AT E_HO ST _NIC _VFS_
C O NFIG
Info
120 2
UP D AT E_HO ST _NIC _VFS_
C O NFIG _FAILED
Erro r
T he acco unt fo r ${UserName}
g o t expi red . P l ease co ntact
the system ad mi ni strato r.
No Ho st i n D ata C enter
' ${Sto rag eP o o l Name}' can
serve as a pro xy to retri eve
remo te VMs i nfo rmati o n
(User: ${UserName}).
Ho st ${Vd sName} canno t be
used as a pro xy to retri eve
remo te VMs i nfo rmati o n si nce
i t i s no t up (User:
${UserName}).
Fai l ed to i mpo rt Vm
${VmName} to D ata C enter
${Sto rag eP o o l Name}, C l uster
${Vd sG ro upName}, co ul d no t
upd ate VM d ata i n expo rt.
R esto ri ng VM ${VmName} fro m
snapsho t started by user
${UserName}.
C D ${D i skName} i s al read y
i nserted to VM ${VmName},
d i sk chang e acti o n was
ski pped . User: ${UserName}.
C D i s al read y ejected fro m
VM ${VmName}, d i sk chang e
acti o n was ski pped . User:
${UserName}.
Starti ng to co nvert Vm
${VmName}
Fai l ed to co nvert Vm
${VmName}
Fai l ed to g et the
co nfi g urati o n o f co nverted
Vm ${VmName}
Fai l ed to pro cess the
co nfi g urati o n o f co nverted
Vm ${VmName}
${Enti tyT ype}
${O l d Enti tyName} was renamed
fro m ${O l d Enti tyName} to
${NewEnti tyName} by
${UserName}.
T he VFs co nfi g urati o n o f
netwo rk i nterface card
${Ni cName} o n ho st
${Vd sName} was upd ated .
Fai l ed to upd ate the VFs
co nfi g urati o n o f netwo rk
i nterface card ${Ni cName} o n
ho st ${Vd sName}.
119 4
119 5
Info
Info
283
REST API ガイド
コード
名前
重大度
メッセージ
120 3
AD D _VFS_C O NFIG _NET WO
RK
Info
120 4
AD D _VFS_C O NFIG _NET WO
R K_FAILED
Info
120 5
R EMO VE_VFS_C O NFIG _NE
T WO R K
Info
120 6
R EMO VE_VFS_C O NFIG _NE
T WO R K_FAILED
Info
120 7
AD D _VFS_C O NFIG _LABEL
Info
120 8
AD D _VFS_C O NFIG _LABEL
_FAILED
Info
120 9
R EMO VE_VFS_C O NFIG _LA
BEL
Info
1210
R EMO VE_VFS_C O NFIG _LA
BEL_FAILED
Info
130 0
NUMA_AD D _VM_NUMA_NO D
E_SUC C ESS
NUMA_AD D _VM_NUMA_NO D
E_FAILED
NUMA_UP D AT E_VM_NUMA_
NO D E_SUC C ESS
NUMA_UP D AT E_VM_NUMA_
NO D E_FAILED
NUMA_R EMO VE_VM_NUMA_N
O D E_SUC C ESS
NUMA_R EMO VE_VM_NUMA_N
O D E_FAILED
Info
Netwo rk ${Netwo rkName} was
ad d ed to the VFs
co nfi g urati o n o f netwo rk
i nterface card ${Ni cName} o n
ho st ${Vd sName}.
Fai l ed to ad d ${Netwo rkName}
to the VFs co nfi g urati o n o f
netwo rk i nterface card
${Ni cName} o n ho st
${Vd sName}.
Netwo rk ${Netwo rkName} was
remo ved fro m the VFs
co nfi g urati o n o f netwo rk
i nterface card ${Ni cName} o n
ho st ${Vd sName}.
Fai l ed to remo ve
${Netwo rkName} fro m the VFs
co nfi g urati o n o f netwo rk
i nterface card ${Ni cName} o n
ho st ${Vd sName}.
Label ${Label } was ad d ed to
the VFs co nfi g urati o n o f
netwo rk i nterface card
${Ni cName} o n ho st
${Vd sName}.
Fai l ed to ad d ${Label } to
the VFs co nfi g urati o n o f
netwo rk i nterface card
${Ni cName} o n ho st
${Vd sName}.
Label ${Label } was remo ved
fro m the VFs co nfi g urati o n
o f netwo rk i nterface card
${Ni cName} o n ho st
${Vd sName}.
Fai l ed to remo ve ${Label }
fro m the VFs co nfi g urati o n
o f netwo rk i nterface card
${Ni cName} o n ho st
${Vd sName}.
Ad d VM NUMA no d e
successful l y.
Ad d VM NUMA no d e fai l ed .
130 1
1310
1311
1320
1321
284
Erro r
Info
Erro r
Info
Erro r
Upd ate VM NUMA no d e
successful l y.
Upd ate VM NUMA no d e fai l ed .
R emo ve VM NUMA no d e
successful l y.
R emo ve VM NUMA no d e fai l ed .
⁠付録C イベントコード
コード
名前
重大度
メッセージ
14 0 2
USER _LO G IN_O N_BEHALF
_FAILED
Erro r
20 0 0
USER _HO T P LUG _D ISK
Info
20 0 1
USER _FAILED _HO T P LUG _
D ISK
Erro r
20 0 2
USER _HO T UNP LUG _D ISK
Info
20 0 3
USER _FAILED _HO T UNP LU
G _D ISK
Erro r
20 0 4
USER _C O P IED _T EMP LAT E
_D ISK
Info
20 0 5
USER _FAILED _C O P Y _T EM
P LAT E_D ISK
Erro r
20 0 6
USER _C O P IED _T EMP LAT E
_D ISK_FINISHED _SUC C E
SS
Info
20 0 7
USER _C O P IED _T EMP LAT E
_D ISK_FINISHED _FAILU
RE
Erro r
20 0 8
USER _MO VED _VM_D ISK
Info
20 0 9
USER _FAILED _MO VED _VM
_D ISK
Erro r
20 10
USER _MO VED _VM_D ISK_F
INISHED _SUC C ESS
Info
20 11
USER _MO VED _VM_D ISK_F
INISHED _FAILUR E
Erro r
20 12
USER _FINISHED _R EMO VE
_D ISK_NO _D O MAIN
Info
20 13
USER _FINISHED _FAILED
_R EMO VE_D ISK_NO _D O MA
IN
Warni ng
Fai l ed to execute l o g i n o n
behal f ${Lo g i nO nBehal fLo g Info }.
VM ${VmName} d i sk
${D i skAl i as} was pl ug g ed by
${UserName}.
Fai l ed to pl ug d i sk
${D i skAl i as} to VM ${VmName}
(User: ${UserName}).
VM ${VmName} d i sk
${D i skAl i as} was unpl ug g ed
by ${UserName}.
Fai l ed to unpl ug d i sk
${D i skAl i as} fro m VM
${VmName} (User:
${UserName}).
User ${UserName} i s co pyi ng
templ ate d i sk ${D i skAl i as}
to d o mai n
${Sto rag eD o mai nName}.
User ${UserName} fai l ed to
co py templ ate d i sk
${D i skAl i as} to d o mai n
${Sto rag eD o mai nName}.
User ${UserName} fi ni shed
co pyi ng templ ate d i sk
${D i skAl i as} to d o mai n
${Sto rag eD o mai nName}.
User ${UserName} fi ni shed
wi th erro r co pyi ng templ ate
d i sk ${D i skAl i as} to d o mai n
${Sto rag eD o mai nName}.
User ${UserName} mo vi ng d i sk
${D i skAl i as} to d o mai n
${Sto rag eD o mai nName}.
User ${UserName} fai l ed to
mo ve d i sk ${D i skAl i as} to
d o mai n ${Sto rag eD o mai nName}.
User ${UserName} fi ni shed
mo vi ng d i sk ${D i skAl i as} to
d o mai n ${Sto rag eD o mai nName}.
User ${UserName} have fai l ed
to mo ve d i sk ${D i skAl i as} to
d o mai n ${Sto rag eD o mai nName}.
D i sk ${D i skAl i as} was
successful l y remo ved (User
${UserName}).
Fai l ed to remo ve d i sk
${D i skAl i as} (User
${UserName}).
285
REST API ガイド
コード
名前
重大度
メッセージ
20 14
USER _FINISHED _R EMO VE
_D ISK
Info
20 15
USER _FINISHED _FAILED
_R EMO VE_D ISK
Warni ng
20 16
USER _AT T AC H_D ISK_T O _
VM
Info
20 17
USER _FAILED _AT T AC H_D
ISK_T O _VM
Erro r
20 18
USER _D ET AC H_D ISK_FR O
M_VM
Info
20 19
USER _FAILED _D ET AC H_D
ISK_FR O M_VM
Erro r
20 20
USER _AD D _D ISK
Info
20 21
USER _AD D _D ISK_FINISH
ED _SUC C ESS
USER _AD D _D ISK_FINISH
ED _FAILUR E
USER _FAILED _AD D _D ISK
Info
D i sk ${D i skAl i as} was
successful l y remo ved fro m
d o mai n ${Sto rag eD o mai nName}
(User ${UserName}).
Fai l ed to remo ve d i sk
${D i skAl i as} fro m sto rag e
d o mai n ${Sto rag eD o mai nName}
(User: ${UserName}).
D i sk ${D i skAl i as} was
successful l y attached to VM
${VmName} by ${UserName}.
Fai l ed to attach D i sk
${D i skAl i as} to VM ${VmName}
(User: ${UserName}).
D i sk ${D i skAl i as} was
successful l y d etached fro m
VM ${VmName} by ${UserName}.
Fai l ed to d etach D i sk
${D i skAl i as} fro m VM
${VmName} (User:
${UserName}).
Ad d -D i sk o perati o n o f
' ${D i skAl i as}' was
i ni ti ated by ${UserName}.
T he d i sk ' ${D i skAl i as}' was
successful l y ad d ed .
Ad d -D i sk o perati o n fai l ed
to co mpl ete.
Ad d -D i sk o perati o n fai l ed
(User: ${UserName}).
USER _R UN_UNLO C K_ENT I
T Y _SC R IP T
USER _MO VE_IMAG E_G R O U
P _FAILED _T O _D ELET E_S
R C _IMAG E
Info
USER _MO VE_IMAG E_G R O U
P _FAILED _T O _D ELET E_D
ST _IMAG E
Warni ng
20 22
20 23
20 24
20 25
20 26
286
Erro r
Erro r
Warni ng
P o ssi bl e fai l ure whi l e
d el eti ng ${D i skAl i as} fro m
the so urce Sto rag e D o mai n
${Sto rag eD o mai nName} d uri ng
the mo ve o perati o n. T he
Sto rag e D o mai n may be
manual l y cl eaned -up fro m
po ssi bl e l efto vers
(User: ${UserName}).
P o ssi bl e fai l ure whi l e
cl eari ng po ssi bl e l efto vers
o f ${D i skAl i as} fro m the
targ et Sto rag e D o mai n
${Sto rag eD o mai nName} after
the mo ve o perati o n fai l ed to
co py the i mag e to i t
pro perl y. T he Sto rag e D o mai n
may be manual l y cl eaned -up
fro m po ssi bl e l efto vers
(User: ${UserName}).
⁠付録C イベントコード
コード
名前
重大度
メッセージ
20 27
USER _IMP O R T _IMAG E
Info
20 28
USER _IMP O R T _IMAG E_FI
NISHED _SUC C ESS
Info
20 29
USER _IMP O R T _IMAG E_FI
NISHED _FAILUR E
Erro r
20 30
USER _EXP O R T _IMAG E
Info
20 31
USER _EXP O R T _IMAG E_FI
NISHED _SUC C ESS
Info
20 32
USER _EXP O R T _IMAG E_FI
NISHED _FAILUR E
Erro r
20 33
HO T _SET _NUMBER _O F_C P
US
Info
20 34
FAILED _HO T _SET _NUMBE
R _O F_C P US
Erro r
20 35
USER _ISC SI_BO ND _HO ST
_R EST AR T _WAR NING
Warni ng
20 36
AD D _D ISK_INT ER NAL
Info
20 37
AD D _D ISK_INT ER NAL_FA
ILUR E
Info
20 38
USER _R EMO VE_D ISK_INI
T IAT ED
Info
User ${UserName} i mpo rti ng
i mag e ${R epo Imag eName} to
d o mai n ${Sto rag eD o mai nName}.
User ${UserName} successful l y
i mpo rted i mag e
${R epo Imag eName} to d o mai n
${Sto rag eD o mai nName}.
User ${UserName} fai l ed to
i mpo rt i mag e
${R epo Imag eName} to d o mai n
${Sto rag eD o mai nName}.
User ${UserName} expo rti ng
i mag e ${R epo Imag eName} to
d o mai n
${D esti nati o nSto rag eD o mai nNa
me}.
User ${UserName} successful l y
expo rted i mag e
${R epo Imag eName} to d o mai n
${D esti nati o nSto rag eD o mai nNa
me}.
User ${UserName} fai l ed to
expo rt i mag e
${R epo Imag eName} to d o mai n
${D esti nati o nSto rag eD o mai nNa
me}.
Ho tpl ug C P U: chang ed the
number o f C P Us o n VM
${vmName} fro m
${previ o usNumberO fC pus} to
${numberO fC pus}
Fai l ed to ho t set number o f
C P US to VM ${vmName}.
Und erl yi ng erro r messag e:
${Erro rMessag e}
T he fo l l o wi ng Netwo rks has
been remo ved fro m the i SC SI
bo nd ${Iscsi Bo nd Name}:
${Netwo rkNames}. fo r tho se
chang es to take affect, the
ho sts must be mo ved to
mai ntenance and acti vated
ag ai n.
Ad d -D i sk o perati o n o f
' ${D i skAl i as}' was
i ni ti ated by the system.
Ad d -D i sk o perati o n o f
' ${D i skAl i as}' fai l ed to
co mpl ete.
R emo val o f D i sk
${D i skAl i as} fro m d o mai n
${Sto rag eD o mai nName} was
i ni ti ated by ${UserName}.
287
REST API ガイド
コード
名前
重大度
メッセージ
20 39
HO T _SET _MEMO R Y
Info
20 4 0
FAILED _HO T _SET _MEMO R
Y
Erro r
30 0 0
USER _AD D _Q UO T A
Info
30 0 1
USER _FAILED _AD D _Q UO T
A
Erro r
30 0 2
USER _UP D AT E_Q UO T A
Info
30 0 3
USER _FAILED _UP D AT E_Q
UO T A
Erro r
30 0 4
USER _D ELET E_Q UO T A
Info
30 0 5
USER _FAILED _D ELET E_Q
UO T A
Erro r
30 0 6
USER _EXC EED ED _Q UO T A_
VD S_G R O UP _G R AC E_LIMI
T
Erro r
30 0 7
USER _EXC EED ED _Q UO T A_
VD S_G R O UP _LIMIT
Warni ng
30 0 8
USER _EXC EED ED _Q UO T A_
VD S_G R O UP _T HR ESHO LD
Warni ng
Ho tset memo ry: chang ed the
amo unt o f memo ry o n VM
${vmName} fro m ${previ o usMem}
to ${newMem}
Fai l ed to ho t set memo ry to
VM ${vmName}. Und erl yi ng
erro r messag e:
${Erro rMessag e}
Q uo ta ${Q uo taName} has been
ad d ed by ${UserName}.
Fai l ed to ad d Q uo ta
${Q uo taName}. T he o perati o n
was i ni ti ated by
${UserName}.
Q uo ta ${Q uo taName} has been
upd ated by ${UserName}.
Fai l ed to upd ate Q uo ta
${Q uo taName}. T he o perati o n
was i ni ti ated by
${UserName}. .
Q uo ta ${Q uo taName} has been
d el eted by ${UserName}.
Fai l ed to d el ete Q uo ta
${Q uo taName}. T he o perati o n
was i ni ti ated by
${UserName}. .
C l uster-Q uo ta ${Q uo taName}
l i mi t exceed ed and o perati o n
was bl o cked . Uti l i zati o n:
${Uti l i zati o n}, R eq uested :
${R eq uested } - P l ease sel ect
a d i fferent q uo ta o r co ntact
yo ur ad mi ni strato r to extend
the q uo ta.
C l uster-Q uo ta ${Q uo taName}
l i mi t exceed ed and entered
the g race zo ne. Uti l i zati o n:
${Uti l i zati o n} (It i s
ad vi sed to sel ect a
d i fferent q uo ta o r co ntact
yo ur ad mi ni strato r to extend
the q uo ta).
C l uster-Q uo ta ${Q uo taName}
i s abo ut to exceed .
Uti l i zati o n: ${Uti l i zati o n}
288
⁠付録C イベントコード
コード
名前
重大度
メッセージ
30 0 9
USER _EXC EED ED _Q UO T A_
ST O R AG E_G R AC E_LIMIT
Erro r
30 10
USER _EXC EED ED _Q UO T A_
ST O R AG E_LIMIT
Warni ng
30 11
USER _EXC EED ED _Q UO T A_
ST O R AG E_T HR ESHO LD
Warni ng
30 12
Q UO T A_ST O R AG E_R ESIZE
_LO WER _T HEN_C O NSUMP T
IO N
Warni ng
30 13
MISSING _Q UO T A_ST O R AG
E_P AR AMET ER S_P ER MISS
IVE_MO D E
MISSING _Q UO T A_C LUST E
R _P AR AMET ER S_P ER MISS
IVE_MO D E
USER _EXC EED ED _Q UO T A_
VD S_G R O UP _G R AC E_LIMI
T _P ER MISSIVE_MO D E
Warni ng
30 16
USER _EXC EED ED _Q UO T A_
ST O R AG E_G R AC E_LIMIT _
P ER MISSIVE_MO D E
Warni ng
4000
G LUST ER _VO LUME_C R EAT
E
Info
Sto rag e-Q uo ta ${Q uo taName}
l i mi t exceed ed and o perati o n
was bl o cked .
Uti l i zati o n(used /req uested ):
${C urrentSto rag e}%/${R eq ueste
d }% - P l ease sel ect a
d i fferent q uo ta o r co ntact
yo ur ad mi ni strato r to extend
the q uo ta.
Sto rag e-Q uo ta ${Q uo taName}
l i mi t exceed ed and entered
the g race zo ne. Uti l i zati o n:
${C urrentSto rag e}% (It i s
ad vi sed to sel ect a
d i fferent q uo ta o r co ntact
yo ur ad mi ni strato r to extend
the q uo ta).
Sto rag e-Q uo ta ${Q uo taName}
i s abo ut to exceed .
Uti l i zati o n:
${C urrentSto rag e}%
Sto rag e-Q uo ta ${Q uo taName}:
the new si ze set fo r thi s
q uo ta i s l ess than current
d i sk uti l i zati o n.
Mi ssi ng Q uo ta fo r D i sk,
pro ceed i ng si nce i n
P ermi ssi ve (Aud i t) mo d e.
Mi ssi ng Q uo ta fo r VM
${VmName}, pro ceed i ng si nce
i n P ermi ssi ve (Aud i t) mo d e.
C l uster-Q uo ta ${Q uo taName}
l i mi t exceed ed , pro ceed i ng
si nce i n P ermi ssi ve (Aud i t)
mo d e. Uti l i zati o n:
${Uti l i zati o n}, R eq uested :
${R eq uested } - P l ease sel ect
a d i fferent q uo ta o r co ntact
yo ur ad mi ni strato r to extend
the q uo ta.
Sto rag e-Q uo ta ${Q uo taName}
l i mi t exceed ed , pro ceed i ng
si nce i n P ermi ssi ve (Aud i t)
mo d e.
Uti l i zati o n(used /req uested ):
${C urrentSto rag e}%/${R eq ueste
d }% - P l ease sel ect a
d i fferent q uo ta o r co ntact
yo ur ad mi ni strato r to extend
the q uo ta.
G l uster Vo l ume
${g l usterVo l umeName} created
o n cl uster ${vd sG ro upName}.
30 14
30 15
Warni ng
Warni ng
289
REST API ガイド
コード
名前
重大度
メッセージ
4001
G LUST ER _VO LUME_C R EAT
E_FAILED
Erro r
4002
G LUST ER _VO LUME_O P T IO
N_AD D ED
G LUST ER _VO LUME_O P T IO
N_SET _FAILED
G LUST ER _VO LUME_ST AR T
Info
C reati o n o f G l uster Vo l ume
${g l usterVo l umeName} fai l ed
o n cl uster ${vd sG ro upName}.
Vo l ume O pti o n ${Key}
Erro r
Vo l ume O pti o n ${Key}
Info
4005
G LUST ER _VO LUME_ST AR T
_FAILED
Erro r
4006
G LUST ER _VO LUME_ST O P
Info
4007
G LUST ER _VO LUME_ST O P _
FAILED
Erro r
4008
G LUST ER _VO LUME_O P T IO
NS_R ESET
G LUST ER _VO LUME_O P T IO
NS_R ESET _FAILED
Info
G l uster Vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}
started .
C o ul d no t start G l uster
Vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
G l uster Vo l ume
${g l usterVo l umeName} sto pped
o n cl uster ${vd sG ro upName}.
C o ul d no t sto p G l uster
Vo l ume ${g l usterVo l umeName}
o n cl uster ${vd sG ro upName}.
Vo l ume O pti o n ${Key}
4 0 10
G LUST ER _VO LUME_D ELET
E
Info
4 0 11
G LUST ER _VO LUME_D ELET
E_FAILED
Erro r
4 0 12
G LUST ER _VO LUME_R EBAL
ANC E_ST AR T
Info
4 0 13
G LUST ER _VO LUME_R EBAL
ANC E_ST AR T _FAILED
Erro r
4 0 14
G LUST ER _VO LUME_R EMO V
E_BR IC KS
Info
4 0 15
G LUST ER _VO LUME_R EMO V
E_BR IC KS_FAILED
Erro r
4 0 16
G LUST ER _VO LUME_R EP LA
C E_BR IC K_FAILED
Erro r
4003
4004
4009
290
Erro r
C o ul d no t reset G l uster
Vo l ume ${g l usterVo l umeName}
O pti o ns o n cl uster
${vd sG ro upName}.
G l uster Vo l ume
${g l usterVo l umeName} d el eted
o n cl uster ${vd sG ro upName}.
C o ul d no t d el ete G l uster
Vo l ume ${g l usterVo l umeName}
o n cl uster ${vd sG ro upName}.
G l uster Vo l ume
${g l usterVo l umeName}
rebal ance started o n cl uster
${vd sG ro upName}.
C o ul d no t start G l uster
Vo l ume ${g l usterVo l umeName}
rebal ance o n cl uster
${vd sG ro upName}.
Bri cks remo ved fro m G l uster
Vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
C o ul d no t remo ve bri cks fro m
G l uster Vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
R epl ace G l uster Vo l ume
${g l usterVo l umeName} Bri ck
fai l ed o n cl uster
${vd sG ro upName}
⁠付録C イベントコード
コード
名前
重大度
メッセージ
4 0 17
G LUST ER _VO LUME_R EP LA
C E_BR IC K_ST AR T
Info
4 0 18
G LUST ER _VO LUME_R EP LA
C E_BR IC K_ST AR T _FAILE
D
Erro r
4 0 19
G LUST ER _VO LUME_AD D _B
R IC K
Info
4 0 20
G LUST ER _VO LUME_AD D _B
R IC K_FAILED
Erro r
4 0 21
G LUST ER _SER VER _R EMO V
E_FAILED
Erro r
4 0 22
G LUST ER _VO LUME_P R O FI
LE_ST AR T
Info
4 0 23
G LUST ER _VO LUME_P R O FI
LE_ST AR T _FAILED
Erro r
4 0 24
G LUST ER _VO LUME_P R O FI
LE_ST O P
Info
4 0 25
G LUST ER _VO LUME_P R O FI
LE_ST O P _FAILED
Erro r
4 0 26
G LUST ER _VO LUME_C R EAT
ED _FR O M_C LI
Warni ng
4 0 27
G LUST ER _VO LUME_D ELET
ED _FR O M_C LI
Info
4 0 28
G LUST ER _VO LUME_O P T IO
N_SET _FR O M_C LI
G LUST ER _VO LUME_O P T IO
N_R ESET _FR O M_C LI
G LUST ER _VO LUME_P R O P E
R T IES_C HANG ED _FR O M_C
LI
Warni ng
G l uster Vo l ume
${g l usterVo l umeName} R epl ace
Bri ck started o n cl uster
${vd sG ro upName}.
C o ul d no t start G l uster
Vo l ume ${g l usterVo l umeName}
R epl ace Bri ck o n cl uster
${vd sG ro upName}.
${No O fBri cks} bri ck(s) ad d ed
to vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
Fai l ed to ad d bri cks to the
G l uster Vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
Fai l ed to remo ve ho st
${Vd sName} fro m C l uster
${Vd sG ro upName}.
G l uster Vo l ume
${g l usterVo l umeName}
pro fi l i ng started o n cl uster
${vd sG ro upName}.
C o ul d no t start pro fi l i ng o n
g l uster vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}
G l uster Vo l ume
${g l usterVo l umeName}
pro fi l i ng sto pped o n cl uster
${vd sG ro upName}.
C o ul d no t sto p P ro fi l i ng o n
g l uster vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
D etected new vo l ume
${g l usterVo l umeName} o n
cl uster ${Vd sG ro upName}, and
ad d ed i t to eng i ne D B.
D etected d el eti o n o f vo l ume
${g l usterVo l umeName} o n
cl uster ${Vd sG ro upName}, and
d el eted i t fro m eng i ne D B.
D etected new o pti o n ${key}
Warni ng
D etected o pti o n ${key}
Warni ng
D etected chang es i n
pro perti es o f vo l ume
${g l usterVo l umeName} o f
cl uster ${Vd sG ro upName}, and
upd ated the same i n eng i ne
D B.
4 0 29
4 0 30
291
REST API ガイド
コード
名前
重大度
メッセージ
4 0 31
G LUST ER _VO LUME_BR IC K
_AD D ED _FR O M_C LI
Warni ng
4 0 32
G LUST ER _VO LUME_BR IC K
_R EMO VED _FR O M_C LI
Info
4 0 33
G LUST ER _SER VER _R EMO V
ED _FR O M_C LI
Info
4 0 34
G LUST ER _VO LUME_INFO _
FAILED
Erro r
4 0 35
G LUST ER _C O MMAND _FAIL
ED
G LUST ER _SER VER _R EMO V
E
G LUST ER _VO LUME_ST AR T
ED _FR O M_C LI
Erro r
4040
G LUST ER _VO LUME_ST O P P
ED _FR O M_C LI
Warni ng
4041
G LUST ER _VO LUME_O P T IO
N_C HANG ED _FR O M_C LI
Info
4042
G LUST ER _HO O K_ENABLE
Info
4043
G LUST ER _HO O K_ENABLE_
FAILED
Erro r
4044
G LUST ER _HO O K_ENABLE_
P AR T IAL
Warni ng
4045
G LUST ER _HO O K_D ISABLE
Info
D etected new bri ck ${bri ck}
o n vo l ume
${g l usterVo l umeName} o f
cl uster ${Vd sG ro upName}, and
ad d ed i t to eng i ne D B.
D etected bri ck ${bri ck}
remo ved fro m Vo l ume
${g l usterVo l umeName} o f
cl uster ${Vd sG ro upName}, and
remo ved i t fro m eng i ne D B.
D etected server ${Vd sName}
remo ved fro m C l uster
${Vd sG ro upName}, and remo ved
i t fro m eng i ne D B.
Fai l ed to fetch g l uster
vo l ume l i st fro m server
${Vd sName}.
G l uster co mmand [${C o mmand }]
fai l ed o n server ${Vd sName}.
Ho st ${Vd sName} remo ved fro m
C l uster ${Vd sG ro upName}.
D etected that Vo l ume
${g l usterVo l umeName} o f
C l uster ${Vd sG ro upName} was
started , and upd ated eng i ne
D B wi th i t' s new status.
D etected that Vo l ume
${g l usterVo l umeName} o f
C l uster ${Vd sG ro upName} was
sto pped , and upd ated eng i ne
D B wi th i t' s new status.
D etected chang e i n val ue o f
o pti o n ${key} fro m
${o l d Val ue} to ${newVal ue}
o n vo l ume
${g l usterVo l umeName} o f
cl uster ${Vd sG ro upName}, and
upd ated i t to eng i ne D B.
G l uster Ho o k
${G l usterHo o kName} enabl ed
o n cl uster ${Vd sG ro upName}.
Fai l ed to enabl e G l uster
Ho o k ${G l usterHo o kName} o n
cl uster ${Vd sG ro upName}.
${Fai l ureMessag e}
G l uster Ho o k
${G l usterHo o kName} enabl ed
o n so me o f the servers o n
cl uster ${Vd sG ro upName}.
${Fai l ureMessag e}
G l uster Ho o k
${G l usterHo o kName} d i sabl ed
o n cl uster ${Vd sG ro upName}.
4 0 38
4 0 39
292
Info
Warni ng
⁠付録C イベントコード
コード
名前
重大度
メッセージ
4046
G LUST ER _HO O K_D ISABLE
_FAILED
Erro r
4047
G LUST ER _HO O K_D ISABLE
_P AR T IAL
Warni ng
4048
G LUST ER _HO O K_LIST _FA
ILED
Erro r
4049
G LUST ER _HO O K_C O NFLIC
T _D ET EC T ED
Warni ng
4 0 50
G LUST ER _HO O K_D ET EC T E Info
D _NEW
4 0 51
G LUST ER _HO O K_D ET EC T E Info
D _D ELET E
4 0 52
G LUST ER _VO LUME_O P T IO
N_MO D IFIED
Info
4 0 53
G LUST ER _HO O K_G ET C O N
T ENT _FAILED
Erro r
4 0 54
G LUST ER _SER VIC ES_LIS
T _FAILED
Erro r
4 0 55
G LUST ER _SER VIC E_T Y P E
_AD D ED _T O _C LUST ER
Info
4 0 56
G LUST ER _C LUST ER _SER V
IC E_ST AT US_C HANG ED
Info
4 0 57
G LUST ER _SER VIC E_AD D E
D _T O _SER VER
Info
4 0 58
G LUST ER _SER VER _SER VI
C E_ST AT US_C HANG ED
Info
4 0 59
G LUST ER _HO O K_UP D AT ED
Info
Fai l ed to d i sabl e G l uster
Ho o k ${G l usterHo o kName} o n
cl uster ${Vd sG ro upName}.
${Fai l ureMessag e}
G l uster Ho o k
${G l usterHo o kName} d i sabl ed
o n so me o f the servers o n
cl uster ${Vd sG ro upName}.
${Fai l ureMessag e}
Fai l ed to retri eve ho o k l i st
fro m ${Vd sName} o f C l uster
${Vd sG ro upName}.
D etected co nfl i ct i n ho o k
${Ho o kName} o f C l uster
${Vd sG ro upName}.
D etected new ho o k
${Ho o kName} i n C l uster
${Vd sG ro upName}.
D etected remo val o f ho o k
${Ho o kName} i n C l uster
${Vd sG ro upName}.
Vo l ume O pti o n ${Key} chang ed
to ${Val ue} fro m ${o l d val ue}
o n ${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
Fai l ed to read co ntent o f
ho o k ${Ho o kName} i n C l uster
${Vd sG ro upName}.
C o ul d no t fetch statuses o f
servi ces fro m server
${Vd sName}. Upd ati ng
statuses o f al l servi ces o n
thi s server to UNKNO WN.
Servi ce type ${Servi ceT ype}
was no t mapped to cl uster
${Vd sG ro upName}. Mapped i t
no w.
Status o f servi ce type
${Servi ceT ype} chang ed fro m
${O l d Status} to ${NewStatus}
o n cl uster ${Vd sG ro upName}
Servi ce ${Servi ceName} was
no t mapped to server
${Vd sName}. Mapped i t no w.
Status o f servi ce
${Servi ceName} o n server
${Vd sName} chang ed fro m
${O l d Status} to ${NewStatus}.
Upd ati ng i n eng i ne no w.
G l uster Ho o k
${G l usterHo o kName} upd ated
o n co nfl i cti ng servers.
293
REST API ガイド
コード
名前
重大度
メッセージ
4060
G LUST ER _HO O K_UP D AT E_
FAILED
Erro r
4061
G LUST ER _HO O K_AD D ED
Info
4062
G LUST ER _HO O K_AD D _FAI
LED
Erro r
4063
G LUST ER _HO O K_R EMO VED
Info
4064
G LUST ER _HO O K_R EMO VE_
FAILED
Erro r
4065
G LUST ER _HO O K_R EFR ESH
Info
4066
G LUST ER _HO O K_R EFR ESH
_FAILED
Erro r
4067
G LUST ER _SER VIC E_ST AR
T ED
Info
4068
G LUST ER _SER VIC E_ST AR
T _FAILED
Erro r
4069
G LUST ER _SER VIC E_ST O P
P ED
Info
4 0 70
G LUST ER _SER VIC E_ST O P
_FAILED
Erro r
4 0 71
G LUST ER _SER VIC ES_LIS
T _NO T _FET C HED
Info
4 0 72
G LUST ER _SER VIC E_R EST
AR T ED
Info
4 0 73
G LUST ER _SER VIC E_R EST
AR T _FAILED
Erro r
4 0 74
G LUST ER _VO LUME_O P T IO
NS_R ESET _ALL
Info
Fai l ed to upd ate G l uster
Ho o k ${G l usterHo o kName} o n
co nfl i cti ng servers.
${Fai l ureMessag e}
G l uster Ho o k
${G l usterHo o kName} ad d ed o n
co nfl i cti ng servers.
Fai l ed to ad d G l uster Ho o k
${G l usterHo o kName} o n
co nfl i cti ng servers.
${Fai l ureMessag e}
G l uster Ho o k
${G l usterHo o kName} remo ved
fro m al l servers i n cl uster
${Vd sG ro upName}.
Fai l ed to remo ve G l uster
Ho o k ${G l usterHo o kName} fro m
cl uster ${Vd sG ro upName}.
${Fai l ureMessag e}
R efreshed g l uster ho o ks i n
C l uster ${Vd sG ro upName}.
Fai l ed to refresh g l uster
ho o ks i n C l uster
${Vd sG ro upName}.
${servi cetype} servi ce
started o n ho st ${Vd sName}
o f cl uster ${Vd sG ro upName}.
C o ul d no t start
${servi cetype} servi ce o n
ho st ${Vd sName} o f cl uster
${Vd sG ro upName}.
${servi cetype} servi ces
sto pped o n ho st ${Vd sName}
o f cl uster ${Vd sG ro upName}.
C o ul d no t sto p
${servi cetype} servi ce o n
ho st ${Vd sName} o f cl uster
${Vd sG ro upName}.
C o ul d no t fetch l i st o f
servi ces fro m
${Servi ceG ro upT ype} named
${Servi ceG ro upName}.
${servi cetype} servi ce restarted o n ho st ${Vd sName}
o n cl uster ${Vd sG ro upName}.
C o ul d no t re-start
${servi cetype} servi ce o n
ho st ${Vd sName} o n cl uster
${Vd sG ro upName}.
Al l Vo l ume O pti o ns reset o n
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
294
⁠付録C イベントコード
コード
名前
重大度
メッセージ
4 0 75
G LUST ER _HO ST _UUID _NO
T _FO UND
Erro r
4 0 76
G LUST ER _VO LUME_BR IC K
_AD D ED
Info
4 0 77
G LUST ER _C LUST ER _SER V
IC E_ST AT US_AD D ED
Info
4 0 78
G LUST ER _VO LUME_R EBAL
ANC E_ST O P
Info
4 0 79
G LUST ER _VO LUME_R EBAL
ANC E_ST O P _FAILED
Erro r
4 0 80
ST AR T _R EMO VING _G LUST
ER _VO LUME_BR IC KS
Info
4 0 81
ST AR T _R EMO VING _G LUST
ER _VO LUME_BR IC KS_FAI
LED
Erro r
4 0 82
G LUST ER _VO LUME_R EMO V
E_BR IC KS_ST O P
Info
4 0 83
G LUST ER _VO LUME_R EMO V
E_BR IC KS_ST O P _FAILED
Erro r
4 0 84
G LUST ER _VO LUME_R EMO V
E_BR IC KS_C O MMIT
Info
4 0 85
G LUST ER _VO LUME_R EMO V
E_BR IC KS_C O MMIT _FAIL
ED
Erro r
4 0 86
G LUST ER _BR IC K_ST AT US
_C HANG ED
Warni ng
4 0 87
G LUST ER _VO LUME_R EBAL
ANC E_FINISHED
Info
C o ul d no t fi nd g l uster uui d
o f server ${Vd sName} o n
C l uster ${Vd sG ro upName}.
Bri ck [${bri ckpath}] o n ho st
[${servername}] ad d ed to
vo l ume
[${g l usterVo l umeName}]
Status o f servi ce type
${Servi ceT ype} set to
${NewStatus} o n cl uster
${Vd sG ro upName}
G l uster Vo l ume
${g l usterVo l umeName}
rebal ance sto pped o f cl uster
${vd sG ro upName}.
C o ul d no t sto p rebal ance o f
g l uster vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
Started remo vi ng bri cks fro m
Vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}
C o ul d no t start remo ve
bri cks fro m Vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}
Sto pped remo vi ng bri cks fro m
Vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}
Fai l ed to sto p remo ve bri cks
fro m Vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}
G l uster vo l ume
${g l usterVo l umeName} remo ve
bri cks co mmi tted o n cl uster
${vd sG ro upName}.
${No O fBri cks} bri ck(s)
remo ved fro m vo l ume
${g l usterVo l umeName}.
G l uster vo l ume
${g l usterVo l umeName} remo ve
bri cks co ul d no t be co mmi ted
o n cl uster ${vd sG ro upName}
D etected chang e i n status o f
bri ck ${bri ckpath} o f vo l ume
${g l usterVo l umeName} fro m
${o l d Val ue} to ${newVal ue}.
${acti o n} ${status} o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
295
REST API ガイド
コード
名前
重大度
メッセージ
4 0 88
G LUST ER _VO LUME_MIG R A
T E_BR IC K_D AT A_FINISH
ED
Info
4 0 89
G LUST ER _VO LUME_R EBAL Info
ANC E_ST AR T _D ET EC T ED _
FR O M_C LI
4090
ST AR T _R EMO VING _G LUST
ER _VO LUME_BR IC KS_D ET
EC T ED _FR O M_C LI
Info
4091
G LUST ER _VO LUME_R EBAL
ANC E_NO T _FO UND _FR O M_
C LI
Warni ng
4092
R EMO VE_G LUST ER _VO LUM
E_BR IC KS_NO T _FO UND _F
R O M_C LI
Warni ng
4093
G LUST ER _VO LUME_D ET AI
LS_R EFR ESH
Info
4094
G LUST ER _VO LUME_D ET AI
LS_R EFR ESH_FAILED
Erro r
4095
G LUST ER _HO ST _UUID _AL
R EAD Y _EXIST S
Erro r
4096
USER _FO R C E_SELEC T ED _
SP M_ST O P _FAILED
Erro r
4097
G LUST ER _G EO R EP _SESSI
O N_D ELET ED _FR O M_C LI
Warni ng
4098
G LUST ER _G EO R EP _SESSI Warni ng
O N_D ET EC T ED _FR O M_C LI
${acti o n} ${status} fo r
bri ck(s) o n vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
P l ease revi ew to abo rt o r
co mmi t.
D etected start o f rebal ance
o n vo l ume
${g l usterVo l umeName} o f
C l uster ${Vd sG ro upName} fro m
C LI.
D etected start o f bri ck
remo val fo r bri cks ${bri ck}
o n vo l ume
${g l usterVo l umeName} o f
C l uster ${Vd sG ro upName} fro m
C LI.
C o ul d no t fi nd i nfo rmati o n
fo r rebal ance o n vo l ume
${g l usterVo l umeName} o f
C l uster ${Vd sG ro upName} fro m
C LI. Marki ng i t as unkno wn.
C o ul d no t fi nd i nfo rmati o n
fo r remo ve bri ck o n vo l ume
${g l usterVo l umeName} o f
C l uster ${Vd sG ro upName} fro m
C LI. Marki ng i t as unkno wn.
R efreshed d etai l s o f the
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
Fai l ed to refresh the
d etai l s o f vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
G l uster UUID o f ho st
${Vd sName} o n C l uster
${Vd sG ro upName} al read y
exi sts.
Fai l ed to fo rce sel ect
${Vd sName} as the SP M d ue to
a fai l ure to sto p the current
SP M.
D etected d el eti o n o f g eo repl i cati o n sessi o n
${g eo R epSessi o nKey} fro m
vo l ume ${g l usterVo l umeName}
D etected new g eo -repl i cati o n
sessi o n ${g eo R epSessi o nKey}
fo r vo l ume
${g l usterVo l umeName}. Ad d i ng
i t to eng i ne.
296
⁠付録C イベントコード
コード
名前
重大度
メッセージ
4099
G LUST ER _G EO R EP _SESSI
O N_R EFR ESH
Info
4 10 0
G LUST ER _G EO R EP _SESSI
O N_R EFR ESH_FAILED
Erro r
4 10 1
G EO R EP _SESSIO N_ST O P
Info
4 10 2
G EO R EP _SESSIO N_ST O P _
FAILED
Erro r
4 10 3
G EO R EP _SESSIO N_D ELET
ED
Info
4 10 4
G EO R EP _SESSIO N_D ELET
E_FAILED
Erro r
4 10 5
G LUST ER _G EO R EP _C O NFI Info
G _SET
4 10 6
G LUST ER _G EO R EP _C O NFI Erro r
G _SET _FAILED
4 10 7
G LUST ER _G EO R EP _C O NFI Info
G _LIST
4 10 8
G LUST ER _G EO R EP _C O NFI Erro r
G _LIST _FAILED
4 10 9
G LUST ER _G EO R EP _C O NFI Info
G _SET _D EFAULT
4 110
G LUST ER _G EO R EP _C O NFI Erro r
G _SET _D EFAULT _FAILED
4 111
G LUST ER _VO LUME_SNAP S
HO T _D ELET ED
G LUST ER _VO LUME_SNAP S
HO T _D ELET E_FAILED
G LUST ER _VO LUME_ALL_S
NAP SHO T S_D ELET ED
Info
G LUST ER _VO LUME_ALL_S
NAP SHO T S_D ELET E_FAIL
ED
Erro r
R efreshed g eo -repl i cati o n
sessi o ns fo r vo l ume
${g l usterVo l umeName}.
Fai l ed to refresh g eo repl i cati o n sessi o ns fo r
vo l ume ${g l usterVo l umeName}.
G eo -repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
has been sto pped .
Fai l ed to sto p g eo repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
G eo -repl i cati o n sessi o n
d el eted o n vo l ume
${g l usterVo l umeName}
Fai l ed to d el ete g eo repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
C o nfi g urati o n ${key} has
been set to ${val ue} o n the
g eo -rep sessi o n
${g eo R epSessi o nKey}.
Fai l ed to set the
co nfi g urati o n ${key} to
${val ue} o n g eo -rep sessi o n
${g eo R epSessi o nKey}.
R efreshed co nfi g urati o n
o pti o ns fo r g eo -repl i cati o n
sessi o n ${g eo R epSessi o nKey}
Fai l ed to refresh
co nfi g urati o n o pti o ns fo r
g eo -repl i cati o n sessi o n
${g eo R epSessi o nKey}
C o nfi g urati o n o f ${key} o f
sessi o n ${g eo R epSessi o nKey}
reset to i ts d efaul t val ue .
Fai l ed to set ${key} o f
sessi o n ${g eo R epSessi o nKey}
to i ts d efaul t val ue.
G l uster vo l ume snapsho t
${snapname} d el eted .
Fai l ed to d el ete g l uster
vo l ume snapsho t ${snapname}.
D el eted al l the g l uster
vo l ume snapsho ts fo r the
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
Fai l ed to d el ete al l the
g l uster vo l ume snapsho ts fo r
the vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
4 112
4 113
4 114
Erro r
Info
297
REST API ガイド
コード
名前
重大度
メッセージ
4 115
G LUST ER _VO LUME_SNAP S
HO T _AC T IVAT ED
Info
4 116
G LUST ER _VO LUME_SNAP S
HO T _AC T IVAT E_FAILED
Erro r
4 117
G LUST ER _VO LUME_SNAP S
HO T _D EAC T IVAT ED
Info
4 118
G LUST ER _VO LUME_SNAP S
HO T _D EAC T IVAT E_FAILE
D
Erro r
4 119
G LUST ER _VO LUME_SNAP S
HO T _R EST O R ED
Info
4 120
G LUST ER _VO LUME_SNAP S
HO T _R EST O R E_FAILED
Erro r
4 121
G LUST ER _VO LUME_SNAP S
HO T _C O NFIG _UP D AT ED
G LUST ER _VO LUME_SNAP S
HO T _C O NFIG _UP D AT E_FA
ILED
G LUST ER _VO LUME_SNAP S
HO T _C O NFIG _UP D AT E_FA
ILED _P AR T IALLY
Info
4 124
NEW_ST O R AG E_D EVIC E_D
ET EC T ED
Info
4 125
ST O R AG E_D EVIC E_R EMO V
ED _FR O M_T HE_HO ST
Info
4 126
SY NC _ST O R AG E_D EVIC ES
_IN_HO ST
SY NC _ST O R AG E_D EVIC ES
_IN_HO ST _FAILED
G EO R EP _O P T IO N_SET _F
R O M_C LI
Info
Acti vated the g l uster vo l ume
snapsho t ${snapname} o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
Fai l ed to acti vate the
g l uster vo l ume snapsho t
${snapname} o n vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
D e-acti vated the g l uster
vo l ume snapsho t ${snapname}
o n vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
Fai l ed to d e-acti vate
g l uster vo l ume snapsho t
${snapname} o n vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
R esto red the vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName} to
the state o f g l uster vo l ume
snapsho t ${snapname}.
Fai l ed to resto re the vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName} to
the state o f g l uster vo l ume
snapsho t ${snapname}.
Upd ated G l uster vo l ume
snapsho t co nfi g urati o n(s).
Fai l ed to upd ate g l uster
vo l ume snapsho t
co nfi g urati o n(s).
Fai l ed to upd ate g l uster
vo l ume snapsho t
co nfi g urati o n(s)
${fai l ed Snapsho tC o nfi g s}.
Fo und new sto rag e d evi ce
${sto rag eD evi ce} o n ho st
${Vd sName}, and ad d ed i t to
eng i ne D B. "
D etected d el eti o n o f sto rag e
d evi ce ${sto rag eD evi ce} o n
ho st ${Vd sName}, and
d el eti ng i t fro m eng i ne D B. "
Manual l y synced the sto rag e
d evi ces fro m ho st ${Vd sName}
Fai l ed to sync sto rag e
d evi ces fro m ho st ${Vd sName}
D etected new o pti o n ${key}
4 122
4 123
4 127
4 128
298
Erro r
Erro r
Erro r
Warni ng
⁠付録C イベントコード
コード
名前
重大度
メッセージ
4 129
G EO R EP _O P T IO N_C HANG
ED _FR O M_C LI
Warni ng
4 130
G LUST ER _MAST ER _VO LUM
E_ST O P _FAILED _D UR ING
_SNAP SHO T _R EST O R E
Erro r
4 131
G LUST ER _MAST ER _VO LUM
E_SNAP SHO T _R EST O R E_F
AILED
G LUST ER _VO LUME_SNAP S
HO T _C R EAT ED
Erro r
4 133
G LUST ER _VO LUME_SNAP S
HO T _C R EAT E_FAILED
Erro r
4 134
G LUST ER _VO LUME_SNAP S
HO T _SC HED ULED
Info
4 135
G LUST ER _VO LUME_SNAP S
HO T _SC HED ULE_FAILED
Erro r
4 136
G LUST ER _VO LUME_SNAP S
HO T _R ESC HED ULED
Info
4 137
G LUST ER _VO LUME_SNAP S
HO T _R ESC HED ULE_FAILE
D
Erro r
4 138
C R EAT E_G LUST ER _BR IC K
Info
4 139
C R EAT E_G LUST ER _BR IC K
_FAILED
Erro r
4 14 0
G LUST ER _G EO _R EP _P UB_
KEY _FET C H_FAILED
G LUST ER _G ET _P UB_KEY
G LUST ER _G EO R EP _P UBLI
C _KEY _WR IT E_FAILED
G LUST ER _WR IT E_P UB_KE
YS
Erro r
D etected chang e i n val ue o f
o pti o n ${key} fro m
${o l d Val ue} to ${val ue} fo r
g eo -repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${Vd sG ro upName},
and upd ated i t to eng i ne.
C o ul d no t sto p master vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}
d uri ng snapsho t resto re.
C o ul d no t resto re master
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
Snapsho t ${snapname} created
fo r vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
C o ul d no t create snapsho t
fo r vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
Snapsho ts sched ul ed o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
Fai l ed to sched ul e snapsho ts
o n the vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
R esched ul ed snapsho ts o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}.
Fai l ed to resched ul e
snapsho ts o n vo l ume
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName}.
Bri ck ${bri ckName} created
successful l y o n ho st
${vd sName} o f cl uster
${vd sG ro upName}.
Fai l ed to create bri ck
${bri ckName} o n ho st
${vd sName} o f cl uster
${vd sG ro upName}.
Fai l ed to fetch publ i c keys.
4 132
4 14 1
4 14 2
4 14 3
Info
Info
Erro r
Info
P ubl i c key fetched .
Fai l ed to wri te publ i c keys
to ${Vd sName}
P ubl i c keys wri tten to
${Vd sName}
299
REST API ガイド
コード
名前
重大度
メッセージ
4 14 4
G LUST ER _G EO R EP _SET UP
_MO UNT _BR O KER _FAILED
Erro r
4 14 5
G LUST ER _SET UP _G EO R EP
_MO UNT _BR O KER
Info
4 14 6
G LUST ER _G EO R EP _SESSI
O N_C R EAT E_FAILED
Erro r
4 14 7
C R EAT E_G LUST ER _VO LUM
E_G EO R EP _SESSIO N
Info
4 14 8
G LUST ER _VO LUME_SNAP S
HO T _SO FT _LIMIT _R EAC H
ED
Info
4 14 9
HO ST _FEAT UR ES_INC O MP
AT IBILE_WIT H_C LUST ER
Erro r
4 150
G LUST ER _VO LUME_SNAP S
HO T _SC HED ULE_D ELET ED
Info
4 151
G LUST ER _BR IC K_ST AT US
_D O WN
Info
4 152
G LUST ER _VO LUME_SNAP S
HO T _D ET EC T ED _NEW
Info
Fai l ed to setup g eo repl i cati o n mo unt bro ker fo r
user ${g eo R epUserName} o n
the sl ave vo l ume
${g eo R epSl aveVo l umeName}.
G eo -repl i cati o n mo unt bro ker
has been setup fo r user
${g eo R epUserName} o n the
sl ave vo l ume
${g eo R epSl aveVo l umeName}.
Fai l ed to create g eo repl i cati o n sessi o n between
master vo l ume :
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName} and
sl ave vo l ume :
${g eo R epSl aveVo l umeName} fo r
the user ${g eo R epUserName}.
C reated g eo -repl i cati o n
sessi o n between master
vo l ume :
${g l usterVo l umeName} o f
cl uster ${vd sG ro upName} and
sl ave vo l ume :
${g eo R epSl aveVo l umeName} fo r
the user ${g eo R epUserName}.
G l uster Vo l ume Snapsho t so ft
l i mi t reached fo r the vo l ume
${g l usterVo l umeName} o n
cl uster ${vd sG ro upName}.
Ho st ${Vd sName} d o es no t
co mpl y wi th the l i st o f
features suppo rted by cl uster
${Vd sG ro upName}.
${UnSuppo rted Feature} i s no t
suppo rted by the Ho st
Snapsho t sched ul e d el eted
fo r vo l ume
${g l usterVo l umeName} o f
${vd sG ro upName}.
Status o f bri ck ${bri ckpath}
o f vo l ume
${g l usterVo l umeName} o n
cl uster ${Vd sG ro upName} i s
d o wn.
Fo und new g l uster vo l ume
snapsho t ${snapname} fo r
vo l ume ${g l usterVo l umeName}
o n cl uster ${Vd sG ro upName},
and ad d ed i t to eng i ne D B. "
300
⁠付録C イベントコード
コード
名前
重大度
メッセージ
4 153
G LUST ER _VO LUME_SNAP S
HO T _D ELET ED _FR O M_C LI
Info
4 154
G LUST ER _VO LUME_SNAP S
HO T _C LUST ER _C O NFIG _D
ET EC T ED _NEW
Info
4 155
G LUST ER _VO LUME_SNAP S
HO T _VO LUME_C O NFIG _D E
T EC T ED _NEW
Info
4 156
G LUST ER _VO LUME_SNAP S
HO T _HAR D _LIMIT _R EAC H
ED
Info
4 157
G LUST ER _C LI_SNAP SHO T
_SC HED ULE_D ISABLE_FA
ILED
G LUST ER _C LI_SNAP SHO T
_SC HED ULE_D ISABLED
Erro r
4 159
SET _UP _P ASSWO R D LESS_
SSH
Info
4 16 0
SET _UP _P ASSWO R D LESS_
SSH_FAILED
Erro r
4 4 36
G LUST ER _SER VER _AD D _F
AILED
Erro r
4 4 37
G LUST ER _SER VER S_LIST
_FAILED
Erro r
4 59 5
G LUST ER _VO LUME_G EO _R
EP _ST AR T _FAILED _EXC E
P T IO N
Erro r
D etected d el eti o n o f g l uster
vo l ume snapsho t ${snapname}
fo r vo l ume
${g l usterVo l umeName} o n
cl uster ${Vd sG ro upName}, and
d el eti ng i t fro m eng i ne D B. "
Fo und new g l uster vo l ume
snapsho t co nfi g urati o n
${snapC o nfi g Name} wi th val ue
${snapC o nfi g Val ue} o n
cl uster ${Vd sG ro upName}, and
ad d ed i t to eng i ne D B. "
Fo und new g l uster vo l ume
snapsho t co nfi g urati o n
${snapC o nfi g Name} wi th val ue
${snapC o nfi g Val ue} fo r
vo l ume ${g l usterVo l umeName}
o n cl uster ${Vd sG ro upName},
and ad d ed i t to eng i ne D B. "
G l uster Vo l ume Snapsho t hard
l i mi t reached fo r the vo l ume
${g l usterVo l umeName} o n
cl uster ${vd sG ro upName}.
Fai l ed to d i sabl e g l uster
C LI based snapsho t sched ul e
o n cl uster ${vd sG ro upName}.
D i sabl ed g l uster C LI based
sched ul i ng successful l y o n
cl uster ${vd sG ro upName}.
P asswo rd -l ess SSH has been
setup fo r user
${g eo R epUserName} o n the
no d es o f remo te vo l ume
${g eo R epSl aveVo l umeName}
fro m the no d es o f the vo l ume
${g l usterVo l umeName}.
Fai l ed to setup P asswo rd l ess
ssh fo r user
${g eo R epUserName} o n the
no d es o f remo te vo l ume
${g eo R epSl aveVo l umeName}
fro m the no d es o f the vo l ume
${g l usterVo l umeName}.
Fai l ed to ad d ho st
${Vd sName} i nto C l uster
${Vd sG ro upName}.
Fai l ed to fetch g l uster peer
l i st fro m server ${Vd sName}
o n C l uster ${Vd sG ro upName}.
Fai l ed to start g eo repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
4 158
Info
301
REST API ガイド
コード
名前
重大度
メッセージ
4 59 6
G LUST ER _VO LUME_G EO _R
EP _ST AR T
Info
4 59 7
G LUST ER _VO LUME_G EO _R
EP _P AUSE_FAILED
Erro r
4 59 8
G LUST ER _VO LUME_G EO _R
EP _R ESUME_FAILED
Erro r
4 59 9
G LUST ER _VO LUME_G EO _R
EP _R ESUME
Info
4600
G LUST ER _VO LUME_G EO _R
EP _P AUSE
Info
9000
VD S_ALER T _FENC E_IS_N
O T _C O NFIG UR ED
Info
9001
VD S_ALER T _FENC E_T EST
_FAILED
Info
9002
VD S_ALER T _FENC E_O P ER
AT IO N_FAILED
Info
9003
VD S_ALER T _FENC E_O P ER
AT IO N_SKIP P ED
Info
9004
VD S_ALER T _FENC E_NO _P
R O XY _HO ST
Info
9005
VD S_ALER T _FENC E_ST AT
US_VER IFIC AT IO N_FAIL
ED
Info
9006
C ANNO T _HIBER NAT E_R UN
NING _VMS_AFT ER _C LUST
ER _C P U_UP G R AD E
Warni ng
G eo -repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
has been started .
Fai l ed to pause g eo repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}
Fai l ed to resume g eo repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}
G eo -repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}
has been resumed .
G eo -repl i cati o n sessi o n o n
vo l ume ${g l usterVo l umeName}
o f cl uster ${vd sG ro upName}
has been paused .
Fai l ed to veri fy P o wer
Manag ement co nfi g urati o n fo r
Ho st ${Vd sName}.
P o wer Manag ement test fai l ed
fo r Ho st
${Vd sName}. ${R easo n}
Fai l ed to po wer fence ho st
${Vd sName}. P l ease check the
ho st status and i t' s po wer
manag ement setti ng s, and
then manual l y rebo o t i t and
cl i ck "C o nfi rm Ho st Has Been
R ebo o ted "
Ho st ${Vd sName} became no n
respo nsi ve. It has no po wer
manag ement co nfi g ured .
P l ease check the ho st status,
manual l y rebo o t i t, and
cl i ck "C o nfi rm Ho st Has Been
R ebo o ted "
T here i s no o ther ho st i n
the d ata center that can be
used to test the po wer
manag ement setti ng s.
Fai l ed to veri fy Ho st
${Ho st} ${Status} status,
P l ease ${Status} Ho st ${Ho st}
manual l y.
Hi bernati o n o f VMs after C P U
upg rad e o f C l uster
${Vd sG ro up} i s no t
suppo rted . P l ease sto p and
restart tho se VMs i n case yo u
wi sh to hi bernate them
302
⁠付録C イベントコード
コード
名前
重大度
メッセージ
9007
VD S_ALER T _SEC O ND AR Y _
AG ENT _USED _FO R _FENC E
_O P ER AT IO N
VD S_HO ST _NO T _R ESP O ND
ING _C O NNEC T ING
Info
9009
VD S_ALER T _P M_HEALT H_
C HEC K_FENC E_AG ENT _NO
N_R ESP O NSIVE
Info
9 0 10
VD S_ALER T _P M_HEALT H_
C HEC K_ST AR T _MIG HT _FA
IL
Info
9 0 11
VD S_ALER T _P M_HEALT H_
C HEC K_ST O P _MIG HT _FAI
L
Info
9 0 12
VD S_ALER T _P M_HEALT H_
C HEC K_R EST AR T _MIG HT _
FAIL
Info
9 0 13
VD S_ALER T _FENC E_O P ER
AT IO N_SKIP P ED _BR O KEN
_C O NNEC T IVIT Y
Info
9 0 14
VD S_ALER T _NO T _R EST AR
T ED _D UE_T O _P O LIC Y
Info
9 0 15
VD S_ALER T _FENC E_D ISA
BLED _BY _C LUST ER _P O LI
CY
Info
9 0 16
FENC E_D ISABLED _IN_C L
UST ER _P O LIC Y
Info
Seco nd ary fence ag ent was
used to ${O perati o n} Ho st
${Vd sName}
Ho st ${Vd sName} i s no t
respo nd i ng . It wi l l stay i n
C o nnecti ng state fo r a g race
peri o d o f ${Seco nd s} seco nd s
and after that an attempt to
fence the ho st wi l l be
i ssued .
Heal th check o n Ho st
${Vd sName} i nd i cates that
Fence-Ag ent ${Ag entId } i s
no n-respo nsi ve.
Heal th check o n Ho st
${Vd sName} i nd i cates that
future attempts to Start thi s
ho st usi ng P o wer-Manag ement
are expected to fai l .
Heal th check o n Ho st
${Vd sName} i nd i cates that
future attempts to Sto p thi s
ho st usi ng P o wer-Manag ement
are expected to fai l .
Heal th check o n Ho st
${Vd sName} i nd i cates that
future attempts to R estart
thi s ho st usi ng P o werManag ement are expected to
fai l .
Ho st ${Vd sName} became no n
respo nsi ve and was no t
restarted d ue to Fenci ng
P o l i cy: ${P ercents} percents
o f the Ho sts i n the C l uster
have co nnecti vi ty i ssues.
Ho st ${Vd sName} became no n
respo nsi ve and was no t
restarted d ue to the C l uster
Fenci ng P o l i cy.
Ho st ${Vd sName} became No n
R espo nsi ve and was no t
restarted d ue to d i sabl ed
fenci ng i n the C l uster
Fenci ng P o l i cy.
Fenci ng i s d i sabl ed i n
Fenci ng P o l i cy o f the
C l uster ${Vd sG ro upName}, so
HA VMs runni ng o n a no nrespo nsi ve ho st wi l l no t be
restarted el sewhere.
9008
Warni ng
303
REST API ガイド
コード
名前
重大度
メッセージ
9 0 17
FENC E_O P ER AT IO N_ST AR
T ED
Info
9 0 18
FENC E_O P ER AT IO N_SUC C
EED ED
Info
9 0 19
FENC E_O P ER AT IO N_FAIL
ED
FENC E_O P ER AT IO N_USIN
G _AG ENT _AND _P R O XY _ST
AR T ED
Erro r
9 0 21
FENC E_O P ER AT IO N_USIN
G _AG ENT _AND _P R O XY _FA
ILED
Warni ng
9 0 22
ENG INE_NO _FULL_BAC KU
P
Info
9 0 23
ENG INE_NO _WAR M_BAC KU
P
Info
9 0 24
ENG INE_BAC KUP _ST AR T E
D
ENG INE_BAC KUP _C O MP LE
T ED
ENG INE_BAC KUP _FAILED
T ASK_ST O P P ING _ASY NC _
T ASK
No rmal
P o wer manag ement ${Acti o n}
o f Ho st ${Vd sName}
i ni ti ated .
P o wer manag ement ${Acti o n}
o f Ho st ${Vd sName}
succeed ed .
P o wer manag ement ${Acti o n}
o f Ho st ${Vd sName} fai l ed .
Executi ng po wer manag ement
${Acti o n} o n Ho st ${Ho st}
usi ng P ro xy Ho st
${P ro xyHo st} and Fence Ag ent
${Ag entT ype}: ${Ag entIp}.
Executi o n o f po wer
manag ement ${Acti o n} o n Ho st
${Ho st} usi ng P ro xy Ho st
${P ro xyHo st} and Fence Ag ent
${Ag entT ype}: ${Ag entIp}
fai l ed .
T here i s no ful l backup
avai l abl e, pl ease run
eng i ne-backup to prevent
d ata l o ss i n case o f
co rrupti o n.
Ful l backup was created o n
${D ate} and i t' s to o o l d .
P l ease run eng i ne-backup to
prevent d ata l o ss i n case o f
co rrupti o n.
Eng i ne backup started .
9 50 1
T ASK_C LEAR ING _ASY NC _
T ASK
Info
9 50 6
USER _AC T IVAT E_ST O R AG
E_D O MAIN_FAILED _ASY N
C
Warni ng
9 0 20
9 0 25
9 0 26
9 50 0
304
Info
No rmal
Erro r
Info
Eng i ne backup co mpl eted
successful l y.
Eng i ne backup fai l ed .
Sto ppi ng async task
${C o mmand Name} that started
at ${D ate}
C l eari ng asynchro no us task
${C o mmand Name} that started
at ${D ate}
Fai l ed to auto reco ver
Sto rag e D o mai n
${Sto rag eD o mai nName} (D ata
C enter ${Sto rag eP o o l Name}).
⁠付録C イベントコード
コード
名前
重大度
メッセージ
9600
IMP O R T EXP O R T _IMP O R T
_VM_INVALID _INT ER FAC
ES
Warni ng
9601
VD S_SET _NO N_O P ER AT IO
NAL_VM_NET WO R K_IS_BR
ID G ELESS
Warni ng
9602
HA_VM_FAILED
Erro r
9603
HA_VM_R EST AR T _FAILED
Erro r
9604
EMULAT ED _MAC HINES_IN
C O MP AT IBLE_WIT H_C LUS
T ER
Warni ng
9605
EXC EED ED _MAXIMUM_NUM
_O F_R EST AR T _HA_VM_AT
T EMP T S
Erro r
9606
IMP O R T EXP O R T _SNAP SH
O T _VM_INVALID _INT ER F
AC ES
Warni ng
9607
AD D _VM_FR O M_SNAP SHO T
_INVALID _INT ER FAC ES
Warni ng
Whi l e i mpo rti ng VM
${Enti tyName}, the Netwo rk/s
${Netwo rks} were fo und to be
No n-VM Netwo rks o r d o no t
exi st i n C l uster o r are
mi ssi ng a sui tabl e VM
netwo rk i nterface pro fi l e.
Netwo rk Name was no t set i n
the Interface/s
${Interfaces}.
Ho st ${Vd sName} d o es no t
co mpl y wi th the cl uster
${Vd sG ro upName} netwo rks, the
fo l l o wi ng VM netwo rks are
no n-VM netwo rks:
' ${Netwo rks}'
Hi g hl y Avai l abl e VM
${VmName} fai l ed . It wi l l be
restarted auto mati cal l y.
R estart o f the Hi g hl y
Avai l abl e VM ${VmName}
fai l ed .
Ho st ${Vd sName} d o es no t
co mpl y wi th the cl uster
${Vd sG ro upName} emul ated
machi ne. T he cl uster
emul ated machi ne i s
${cl usterEmul ated Machi nes}
and the ho st emul ated
machi nes are
${ho stSuppo rted Emul ated Machi
nes}.
Hi g hl y Avai l abl e VM
${VmName} co ul d no t be
restarted auto mati cal l y,
exceed ed the maxi mum number
o f attempts.
Whi l e previ ewi ng a snapsho t
o f VM ${Enti tyName}, the
Netwo rk/s ${Netwo rks} were
fo und to be No n-VM Netwo rks
o r d o no t exi st i n C l uster.
Netwo rk Name was no t set i n
the Interface/s
${Interfaces}.
Whi l e ad d i ng vm
${Enti tyName} fro m snapsho t,
the Netwo rk/s ${Netwo rks}
were fo und to be No n-VM
Netwo rks o r d o no t exi st i n
C l uster. Netwo rk Name was
no t set i n the Interface/s
${Interfaces}.
305
REST API ガイド
コード
名前
重大度
メッセージ
9608
R NG _SO UR C ES_INC O MP AT
IBLE_WIT H_C LUST ER
Warni ng
9609
EMULAT ED _MAC HINES_IN
C O MP AT IBLE_WIT H_C LUS
T ER _LEVEL
Warni ng
9 6 10
MIXING _R HEL_VER SIO NS
_IN_C LUST ER
Warni ng
9 70 0
9 70 1
9 70 4
9 80 1
D WH_ST AR T ED
D WH_ST O P P ED
D WH_ER R O R
EXT ER NAL_EVENT _NO R MA
L
Info
Info
Erro r
Info
9 80 2
EXT ER NAL_EVENT _WAR NI
NG
Warni ng
9 80 3
EXT ER NAL_EVENT _ER R O R
Erro r
9 80 4
EXT ER NAL_ALER T
Info
9901
WAT C HD O G _EVENT
Warni ng
9 9 10
USER _AD D _C LUST ER _P O L
IC Y
Info
9 9 11
USER _FAILED _T O _AD D _C
LUST ER _P O LIC Y
Erro r
9 9 12
USER _UP D AT E_C LUST ER _
P O LIC Y
Info
Ho st ${Vd sName} d o es no t
co mpl y wi th the cl uster
${Vd sG ro upName} R and o m
Number G enerato r so urces.
T he Ho sts suppo rted so urces
are:
${ho stSuppo rted R ng So urces};
and the cl uster req ui rements
are:
${cl usterR eq ui red R ng So urces}
.
Ho st ${Vd sName} d o es no t
co mpl y wi th the cl uster
${Vd sG ro upName} emul ated
machi nes. T he current cl uster
co mpati bi l i ty l evel suppo rts
${cl usterEmul ated Machi nes}
and the ho st emul ated
machi nes are
${ho stSuppo rted Emul ated Machi
nes}.
No t po ssi bl e to mi x R HEL
6 . x and 7. x ho sts i n o ne
cl uster. T ri ed ad d i ng
${ad d i ng R hel } ho st to a
cl uster wi th ${previ o usR hel }
ho sts.
ET L Servi ce started .
ET L Servi ce sto pped .
Erro r i n ET L Servi ce.
An external event wi th
NO R MAL severi ty has been
ad d ed .
An external event wi th
WAR NING severi ty has been
ad d ed .
An external event wi th ER R O R
severi ty has been ad d ed .
An external event wi th ALER T
severi ty has been ad d ed .
Watchd o g event (${wd acti o n})
tri g g ered o n ${VmName} at
${wd event} (ho st ti me).
Sched ul i ng P o l i cy
${C l usterP o l i cy} was ad d ed .
(User: ${UserName})
Fai l ed to ad d Sched ul i ng
P o l i cy: ${C l usterP o l i cy}.
(User: ${UserName})
Sched ul i ng P o l i cy
${C l usterP o l i cy} was
upd ated . (User: ${UserName})
306
⁠付録C イベントコード
コード
名前
重大度
メッセージ
9 9 13
USER _FAILED _T O _UP D AT
E_C LUST ER _P O LIC Y
Erro r
9 9 14
USER _R EMO VE_C LUST ER _
P O LIC Y
Info
9 9 15
USER _FAILED _T O _R EMO V
E_C LUST ER _P O LIC Y
Erro r
9 9 20
FAILED _T O _C O NNEC T _T O
_SC HED ULER _P R O XY
Erro r
10 0 0 0
VD S_UNT R UST ED
Erro r
10 0 0 1
USER _UP D AT E_VM_FR O M_
T R UST ED _T O _UNT R UST E
D
USER _UP D AT E_VM_FR O M_
UNT R UST ED _T O _T R UST E
D
IMP O R T EXP O R T _IMP O R T
_VM_FR O M_T R UST ED _T O _
UNT R UST ED
Warni ng
10 0 0 4
IMP O R T EXP O R T _IMP O R T
_VM_FR O M_UNT R UST ED _T
O _T R UST ED
Warni ng
10 0 0 5
USER _AD D _VM_FR O M_T R U
ST ED _T O _UNT R UST ED
Warni ng
10 0 0 6
USER _AD D _VM_FR O M_UNT
R UST ED _T O _T R UST ED
Warni ng
10 0 0 7
IMP O R T EXP O R T _IMP O R T
_T EMP LAT E_FR O M_T R UST
ED _T O _UNT R UST ED
Warni ng
Fai l ed to upd ate Sched ul i ng
P o l i cy: ${C l usterP o l i cy}.
(User: ${UserName})
Sched ul i ng P o l i cy
${C l usterP o l i cy} was
remo ved . (User: ${UserName})
Fai l ed to remo ve Sched ul i ng
P o l i cy: ${C l usterP o l i cy}.
(User: ${UserName})
Fai l ed to co nnect to
external sched ul er pro xy.
External fi l ters, sco ri ng
functi o ns and l o ad
bal anci ng wi l l no t be
perfo rmed .
Ho st ${Vd sName} was set to
no n-o perati o nal . Ho st i s no t
trusted by the attestati o n
servi ce.
T he VM ${VmName} was upd ated
fro m trusted cl uster to no ntrusted cl uster.
T he VM ${VmName} was upd ated
fro m no n-trusted cl uster to
trusted cl uster.
T he VM ${VmName} was created
i n trusted cl uster and
i mpo rted i nto a no n-trusted
cl uster
T he VM ${VmName} was created
i n no n-trusted cl uster and
i mpo rted i nto a trusted
cl uster
T he VM ${VmName} was created
i n an untrusted cl uster. It
was o ri g i nated fro m the
T empl ate ${VmT empl ateName}
whi ch was created i n a
trusted cl uster.
T he VM ${VmName} was created
i n a trusted cl uster. It was
o ri g i nated fro m the T empl ate
${VmT empl ateName} whi ch was
created i n an untrusted
cl uster.
T he T empl ate
${VmT empl ateName} was created
i n trusted cl uster and
i mpo rted i nto a no n-trusted
cl uster
10 0 0 2
10 0 0 3
Warni ng
Warni ng
307
REST API ガイド
コード
名前
重大度
メッセージ
10 0 0 8
IMP O R T EXP O R T _IMP O R T
_T EMP LAT E_FR O M_UNT R U
ST ED _T O _T R UST ED
Warni ng
10 0 0 9
USER _AD D _VM_T EMP LAT E
_FR O M_T R UST ED _T O _UNT
R UST ED
USER _AD D _VM_T EMP LAT E
_FR O M_UNT R UST ED _T O _T
R UST ED
Warni ng
T he T empl ate
${VmT empl ateName} was created
i n no n-trusted cl uster and
i mpo rted i nto a trusted
cl uster
T he no n-trusted T empl ate
${VmT empl ateName} was created
fro m trusted Vm ${VmName}.
T he trusted templ ate
${VmT empl ateName} was created
fro m no n-trusted Vm
${VmName}.
T he T empl ate
${VmT empl ateName} was
upd ated fro m trusted cl uster
to no n-trusted cl uster.
T he T empl ate
${VmT empl ateName} was
upd ated fro m no n-trusted
cl uster to trusted cl uster.
Netwo rk Q o S ${Q o sName} was
ad d ed . (User: ${UserName})
Fai l ed to ad d Netwo rk Q o S
${Q o sName}. (User:
${UserName})
Netwo rk Q o S ${Q o sName} was
remo ved . (User: ${UserName})
Fai l ed to remo ve Netwo rk Q o S
${Q o sName}. (User:
${UserName})
Netwo rk Q o S ${Q o sName} was
upd ated . (User: ${UserName})
Fai l ed to upd ate Netwo rk Q o S
${Q o sName}. (User:
${UserName})
Q o S ${Q o SName} was ad d ed .
(User: ${UserName})
Fai l ed to ad d Q o S
${Q o SName}. (User:
${UserName})
Q o S ${Q o SName} was remo ved .
(User: ${UserName})
Fai l ed to remo ve Q o S
${Q o SName}. (User:
${UserName})
Q o S ${Q o SName} was upd ated .
(User: ${UserName})
Fai l ed to upd ate Q o S
${Q o SName}. (User:
${UserName})
10 0 10
Warni ng
10 0 11
USER _UP D AT E_VM_T EMP L Warni ng
AT E_FR O M_T R UST ED _T O _
UNT R UST ED
10 0 12
USER _UP D AT E_VM_T EMP L
AT E_FR O M_UNT R UST ED _T
O _T R UST ED
Warni ng
10 10 0
USER _AD D ED _NET WO R K_Q
OS
USER _FAILED _T O _AD D _N
ET WO R K_Q O S
Info
USER _R EMO VED _NET WO R K
_Q O S
USER _FAILED _T O _R EMO V
E_NET WO R K_Q O S
Info
USER _UP D AT ED _NET WO R K
_Q O S
USER _FAILED _T O _UP D AT
E_NET WO R K_Q O S
Info
10 110
USER _AD D ED _Q O S
Info
10 111
USER _FAILED _T O _AD D _Q
OS
Erro r
10 112
USER _R EMO VED _Q O S
Info
10 113
USER _FAILED _T O _R EMO V
E_Q O S
Erro r
10 114
USER _UP D AT ED _Q O S
Info
10 115
USER _FAILED _T O _UP D AT
E_Q O S
Erro r
10 10 1
10 10 2
10 10 3
10 10 4
10 10 5
308
Erro r
Erro r
Erro r
⁠付録C イベントコード
コード
名前
重大度
メッセージ
10 120
USER _AD D ED _D ISK_P R O F
ILE
Info
10 121
USER _FAILED _T O _AD D _D
ISK_P R O FILE
USER _R EMO VED _D ISK_P R
O FILE
Erro r
10 123
USER _FAILED _T O _R EMO V
E_D ISK_P R O FILE
Erro r
10 124
USER _UP D AT ED _D ISK_P R
O FILE
Info
10 125
USER _FAILED _T O _UP D AT
E_D ISK_P R O FILE
Erro r
10 130
USER _AD D ED _C P U_P R O FI Info
LE
10 131
USER _FAILED _T O _AD D _C
P U_P R O FILE
USER _R EMO VED _C P U_P R O
FILE
Erro r
10 133
USER _FAILED _T O _R EMO V
E_C P U_P R O FILE
Erro r
10 134
USER _UP D AT ED _C P U_P R
O FILE
Info
10 135
USER _FAILED _T O _UP D AT
E_C P U_P R O FILE
Erro r
10 20 0
USER _UP D AT ED _MO M_P O L
IC IES
USER _FAILED _T O _UP D AT
E_MO M_P O LIC IES
P M_P O LIC Y _UP _T O _MAIN
T ENANC E
Info
P M_P O LIC Y _MAINT ENANC
E_T O _D O WN
P M_P O LIC Y _T O _UP
Info
D i sk P ro fi l e ${P ro fi l eName}
was successful l y ad d ed
(User: ${UserName}).
Fai l ed to ad d D i sk P ro fi l e
(User: ${UserName}).
D i sk P ro fi l e ${P ro fi l eName}
was successful l y remo ved
(User: ${UserName}).
Fai l ed to remo ve D i sk
P ro fi l e ${P ro fi l eName}
(User: ${UserName}).
D i sk P ro fi l e ${P ro fi l eName}
was successful l y upd ated
(User: ${UserName}).
Fai l ed to upd ate D i sk
P ro fi l e ${P ro fi l eName}
(User: ${UserName}).
C P U P ro fi l e ${P ro fi l eName}
was successful l y ad d ed
(User: ${UserName}).
Fai l ed to ad d C P U P ro fi l e
(User: ${UserName}).
C P U P ro fi l e ${P ro fi l eName}
was successful l y remo ved
(User: ${UserName}).
Fai l ed to remo ve C P U
P ro fi l e ${P ro fi l eName}
(User: ${UserName}).
C P U P ro fi l e ${P ro fi l eName}
was successful l y upd ated
(User: ${UserName}).
Fai l ed to upd ate C P U
P ro fi l e ${P ro fi l eName}
(User: ${UserName}).
Mo m po l i cy was upd ated o n
ho st ${Vd sName}.
Mo m po l i cy co ul d no t be
upd ated o n ho st ${Vd sName}.
Ho st ${Ho st} i s no t currentl y
need ed , acti vati ng
mai ntenance mo d e i n
preparati o n fo r shutd o wn.
Ho st ${Ho st} i s no t currentl y
need ed , shutti ng d o wn.
R eacti vati ng ho st ${Ho st}
acco rd i ng to the current
po wer manag ement po l i cy.
10 122
10 132
10 20 1
10 250
10 251
10 252
Info
Info
Warni ng
Info
Info
309
REST API ガイド
コード
名前
重大度
メッセージ
10 30 0
C LUST ER _ALER T _HA_R ES
ER VAT IO N
Info
10 30 1
C LUST ER _ALER T _HA_R ES
ER VAT IO N_D O WN
Info
10 350
USER _AD D ED _AFFINIT Y _
G R O UP
Info
10 351
USER _FAILED _T O _AD D _A
FFINIT Y _G R O UP
Erro r
10 352
USER _UP D AT ED _AFFINIT
Y _G R O UP
Info
10 353
USER _FAILED _T O _UP D AT
E_AFFINIT Y _G R O UP
Erro r
10 354
USER _R EMO VED _AFFINIT
Y _G R O UP
Info
10 355
USER _FAILED _T O _R EMO V
E_AFFINIT Y _G R O UP
Erro r
10 4 0 0
ISC SI_BO ND _AD D _SUC C E
SS
Info
10 4 0 1
ISC SI_BO ND _AD D _FAILE
D
Erro r
10 4 0 2
ISC SI_BO ND _ED IT _SUC C
ESS
Info
10 4 0 3
ISC SI_BO ND _ED IT _FAIL
ED
ISC SI_BO ND _R EMO VE_SU
C C ESS
Erro r
ISC SI_BO ND _R EMO VE_FA
ILED
Erro r
C l uster ${C l usterName}
fai l ed the HA R eservati o n
check, HA VMs o n ho st(s):
${Ho sts} wi l l fai l to
mi g rate i n case o f a
fai l o ver, co nsi d er ad d i ng
reso urces o r shutti ng d o wn
unused VMs.
C l uster ${C l usterName}
passed the HA R eservati o n
check.
Affi ni ty G ro up
${affi ni tyG ro upName} was
ad d ed . (User: ${UserName})
Fai l ed to ad d Affi ni ty
G ro up ${affi ni tyG ro upName}.
(User: ${UserName})
Affi ni ty G ro up
${affi ni tyG ro upName} was
upd ated . (User: ${UserName})
Fai l ed to upd ate Affi ni ty
G ro up ${affi ni tyG ro upName}.
(User: ${UserName})
Affi ni ty G ro up
${affi ni tyG ro upName} was
remo ved . (User: ${UserName})
Fai l ed to remo ve Affi ni ty
G ro up ${affi ni tyG ro upName}.
(User: ${UserName})
i SC SI bo nd
' ${Iscsi Bo nd Name}' was
successful l y created i n D ata
C enter ' ${Sto rag eP o o l Name}' .
Fai l ed to create i SC SI bo nd
' ${Iscsi Bo nd Name}' i n D ata
C enter ' ${Sto rag eP o o l Name}' .
i SC SI bo nd
' ${Iscsi Bo nd Name}' was
successful l y upd ated .
Fai l ed to upd ate i SC SI bo nd
' ${Iscsi Bo nd Name}' .
i SC SI bo nd
' ${Iscsi Bo nd Name}' was
remo ved fro m D ata C enter
' ${Sto rag eP o o l Name}'
Fai l ed to remo ve i SC SI bo nd
' ${Iscsi Bo nd Name}' fro m D ata
C enter ' ${Sto rag eP o o l Name}'
10 4 0 4
10 4 0 5
310
Info
⁠付録C イベントコード
コード
名前
重大度
メッセージ
10 4 0 6
ISC SI_BO ND _ED IT _SUC C
ESS_WIT H_WAR NING
Warni ng
10 4 0 7
ISC SI_BO ND _AD D _SUC C E
SS_WIT H_WAR NING
Warni ng
10 4 50
USER _SET _HO ST ED _ENG I
NE_MAINT ENANC E
Info
10 4 51
USER _FAILED _T O _SET _H
O ST ED _ENG INE_MAINT EN
ANC E
VD S_MAINT ENANC E_MANU
AL_HA
Erro r
10 4 53
USER _VD S_MAINT ENANC E
_MANUAL_HA
Warni ng
10 4 54
VD S_AC T IVAT E_MANUAL_
HA
Warni ng
10 4 55
VD S_AC T IVAT E_MANUAL_
HA_ASY NC
Warni ng
10 4 56
HO ST ED _ENG INE_VM_IMP
O R T _SUC C EED ED
HO ST ED _ENG INE_D O MAIN
_IMP O R T _SUC C EED ED
HO ST ED _ENG INE_D O MAIN
_IMP O R T _FAILED
EXT ER NAL_SC HED ULER _P
LUG IN_ER R O R
No rmal
i SC SI bo nd
' ${Iscsi Bo nd Name}' was
successful l y upd ated but
so me o f the ho sts
enco untered co nnecti o n
i ssues.
i SC SI bo nd
' ${Iscsi Bo nd Name}' was
successful l y created i n D ata
C enter ' ${Sto rag eP o o l Name}'
but so me o f the ho sts
enco untered co nnecti o n
i ssues.
Ho sted Eng i ne HA mai ntenance
mo d e was upd ated o n ho st
${Vd sName}.
Ho sted Eng i ne HA mai ntenance
mo d e co ul d no t be upd ated
o n ho st ${Vd sName}.
Ho st ${Vd sName} was swi tched
to Mai ntenance mo d e, but
Ho sted Eng i ne HA mai ntenance
co ul d no t be enabl ed .
P l ease enabl e i t manual l y.
Ho st ${Vd sName} was swi tched
to Mai ntenance mo d e by
${UserName}, but Ho sted
Eng i ne HA mai ntenance co ul d
no t be enabl ed . P l ease
enabl e i t manual l y.
Ho st ${Vd sName} was
acti vated by ${UserName}, but
the Ho sted Eng i ne HA servi ce
may sti l l be i n mai ntenance
mo d e. If necessary, pl ease
co rrect thi s manual l y.
Ho st ${Vd sName} was
auto reco vered , but the Ho sted
Eng i ne HA servi ce may sti l l
be i n mai ntenance mo d e. If
necessary, pl ease co rrect
thi s manual l y.
Ho sted Eng i ne VM was
i mpo rted successful l y
Ho sted Eng i ne sto rag e d o mai n
i mpo rted successful l y
Fai l ed to i mpo rt the Ho sted
Eng i ne Sto rag e D o mai n
R unni ng the external
sched ul er pl ug i n
' ${P l ug i nName}' fai l ed :
' ${Erro rMessag e}'
10 4 52
10 4 6 0
10 4 6 1
10 50 0
Warni ng
No rmal
Erro r
Erro r
311
REST API ガイド
コード
名前
重大度
メッセージ
10 50 1
EXT ER NAL_SC HED ULER _E
RROR
Erro r
10 550
VM_SLA_P O LIC Y
Info
10 551
FAILED _VM_SLA_P O LIC Y
Erro r
10 6 0 0
USER _R EMO VE_AUD IT _LO
G
Info
10 6 0 1
USER _R EMO VE_AUD IT _LO
G _FAILED
Erro r
R unni ng the external
sched ul er fai l ed :
' ${Erro rMessag e}'
VM ${VmName} SLA P o l i cy was
set. C P U l i mi t i s set to
${cpuLi mi t}
Fai l ed to set SLA P o l i cy to
VM ${VmName}. Und erl yi ng
erro r messag e:
${Erro rMessag e}
Event l i st messag e
${Aud i tLo g Id } was remo ved by
User ${UserName}.
User ${UserName} fai l ed to
remo ve event l i st messag e
${Aud i tLo g Id }.
10 6 0 2
Info
10 70 0
USER _C LEAR _ALL_AUD IT
_LO G
USER _C LEAR _ALL_AUD IT
_LO G _FAILED
USER _D ISP LAY _ALL_AUD
IT _LO G
USER _D ISP LAY _ALL_AUD
IT _LO G _FAILED
MAC _P O O L_AD D _SUC C ESS
10 70 1
MAC _P O O L_AD D _FAILED
Erro r
10 70 2
MAC _P O O L_ED IT _SUC C ES
S
MAC _P O O L_ED IT _FAILED
Info
MAC _P O O L_R EMO VE_SUC C
ESS
MAC _P O O L_R EMO VE_FAIL
ED
C IND ER _P R O VID ER _ER R
OR
Info
10 751
C IND ER _D ISK_C O NNEC T I
O N_FAILUR E
Erro r
10 752
C IND ER _D ISK_C O NNEC T I
O N_VO LUME_D R IVER _UNS
UP P O R T ED
Erro r
10 6 0 3
10 6 0 4
10 6 0 5
10 70 3
10 70 4
10 70 5
10 750
312
Erro r
Info
Erro r
Info
Erro r
Erro r
Erro r
MAC P o o l ' ${MacP o o l Name}'
(i d
Fai l ed to create MAC P o o l
' ${MacP o o l Name}' . (User:
${UserName})
MAC P o o l ' ${MacP o o l Name}'
(i d
Fai l ed to upd ate MAC P o o l
' ${MacP o o l Name}' (i d
MAC P o o l ' ${MacP o o l Name}'
(i d
Fai l ed to remo ve MAC P o o l
' ${MacP o o l Name}' (i d
An erro r o ccurred o n C i nd er
pro vi d er:
' ${C i nd erExcepti o n}'
Fai l ed to retri eve
co nnecti o n i nfo rmati o n fo r
C i nd er D i sk ' ${D i skAl i as}' .
Unsuppo rted vo l ume d ri ver
fo r C i nd er D i sk
' ${D i skAl i as}' .
⁠付録C イベントコード
コード
名前
重大度
メッセージ
10 753
USER _FINISHED _FAILED
_R EMO VE_C IND ER _D ISK
Erro r
10 754
USER _AD D ED _LIBVIR T _S
EC R ET
Info
10 755
USER _FAILED _T O _AD D _L
IBVIR T _SEC R ET
Erro r
10 756
USER _UP D AT E_LIBVIR T _
SEC R ET
Info
10 757
USER _FAILED _T O _UP D AT
E_LIBVIR T _SEC R ET
Erro r
10 758
USER _R EMO VED _LIBVIR T
_SEC R ET
Info
10 759
USER _FAILED _T O _R EMO V
E_LIBVIR T _SEC R ET
Erro r
10 76 0
FAILED _T O _R EG IST ER _L
IBVIR T _SEC R ET
Erro r
10 76 1
FAILED _T O _UNR EG IST ER
_LIBVIR T _SEC R ET
Erro r
10 76 2
FAILED _T O _R EG IST ER _L
IBVIR T _SEC R ET _O N_VD S
Erro r
10 76 3
NO _LIBR BD _P AC KAG E_AV
AILABLE_O N_VD S
Erro r
10 76 4
FAILED _T O _FR EEZE_VM
Warni ng
Fai l ed to remo ve d i sk
${D i skAl i as} fro m sto rag e
d o mai n ${Sto rag eD o mai nName}.
T he fo l l o wi ng enti ty i d
co ul d no t be d el eted fro m
the C i nd er pro vi d er
' ${i mag eId }' . (User:
${UserName}).
Authenti cati o n Key
${Li bvi rtSecretUUID } was
ad d ed . (User: ${UserName}).
Fai l ed to ad d Authenti cati o n
Key ${Li bvi rtSecretUUID }.
(User: ${UserName}).
Authenti cati o n Key
${Li bvi rtSecretUUID } was
upd ated . (User:
${UserName}).
Fai l ed to upd ate
Authenti cati o n Key
${Li bvi rtSecretUUID }. (User:
${UserName}).
Authenti cati o n Key
${Li bvi rtSecretUUID } was
remo ved . (User:
${UserName}).
Fai l ed to remo ve
Authenti cati o n Key
${Li bvi rtSecretUUID }. (User:
${UserName}).
Fai l ed to reg i ster
Authenti cati o n Keys fo r
sto rag e d o mai n
${Sto rag eD o mai nName} o n ho st
${Vd sName}.
Fai l ed to unreg i ster
Authenti cati o n Keys fo r
sto rag e d o mai n
${Sto rag eD o mai nName} o n ho st
${Vd sName}.
Fai l ed to reg i ster
Authenti cati o n Keys o n ho st
${Vd sName}.
Li brbd 1 packag e i s no t
avai l abl e o n ho st
${Vd sName}, whi ch i s
mand ato ry fo r usi ng C i nd er
sto rag e d o mai ns.
Fai l ed to freeze g uest
fi l esystems o n VM ${VmName}.
No te that usi ng the created
snapsho t mi g ht cause d ata
i nco nsi stency.
313
REST API ガイド
コード
名前
重大度
メッセージ
10 76 5
FAILED _T O _T HAW_VM
Warni ng
10 76 6
FR EEZE_VM_INIT IAT ED
No rmal
10 76 7
FR EEZE_VM_SUC C ESS
No rmal
10 76 8
T HAW_VM_SUC C ESS
No rmal
10 76 9
USER _FAILED _T O _FR EEZ
E_VM
Warni ng
10 770
USER _FAILED _T O _T HAW_
VM
Warni ng
10 771
VD S_C ANNO T _C O NNEC T _T
O _G LUST ER FS
Erro r
10 780
AFFINIT Y _R ULES_ENFO R
C EMENT _MANAG ER _ST AR T
AFFINIT Y _R ULES_ENFO R
C EMENT _MANAG ER _INT ER
VAL_R EAC HED
VM_AD D _HO ST _D EVIC ES
No rmal
Fai l ed to thaw g uest
fi l esystems o n VM ${VmName}.
T he fi l esystems mi g ht be
unrespo nsi ve unti l the VM i s
restarted .
Freeze o f g uest fi l esystems
o n VM ${VmName} was
i ni ti ated .
G uest fi l esystems o n VM
${VmName} have been fro zen
successful l y.
G uest fi l esystems o n VM
${VmName} have been thawed
successful l y.
Fai l ed to freeze g uest
fi l esystems o n ${VmName}
(Ho st: ${Vd sName}, User:
${UserName}).
Fai l ed to thaw g uest
fi l esystems o n ${VmName}
(Ho st: ${Vd sName}, User:
${UserName}).
Ho st ${Vd sName} canno t
co nnect to G l usterfs. Veri fy
that g l usterfs-cl i packag e
i s i nstal l ed o n the ho st.
Affi ni ty R ul es Enfo rcement
Manag er started .
10 80 1
VM_R EMO VE_HO ST _D EVIC
ES
Info
10 80 2
VD S_BR O KER _C O MMAND _F
AILUR E
IR S_BR O KER _C O MMAND _F
AILUR E
VD S_UNKNO WN_HO ST
Erro r
SY ST EM_C HANG E_ST O R AG
E_P O O L_ST AT US_UP _R EP
O R T ING _HO ST S
No rmal
10 781
10 80 0
10 80 3
10 80 4
10 810
314
No rmal
Info
Erro r
Erro r
Ho st d evi ces ${NamesAd d ed }
were attached to Vm ${VmName}
by User ${UserName}.
Ho st d evi ces ${NamesR emo ved }
were d etached fro m Vm
${VmName} by User
${UserName}.
VD SM ${Vd sName} co mmand
fai l ed : ${messag e}
VD SM co mmand fai l ed :
${messag e}
T he ad d ress o f ho st
${Vd sName} co ul d no t be
d etermi ned
D ata C enter
${Sto rag eP o o l Name} status
was chang ed to UP as so me o f
i ts ho sts are i n status UP .
⁠付録C イベントコード
コード
名前
重大度
メッセージ
10 811
SY ST EM_C HANG E_ST O R AG
E_P O O L_ST AT US_NO N_R E
SP O NSIVE_NO _R EP O R T IN
G _HO ST S
Info
10 9 0 0
HO ST _SY NC _ALL_NET WO R
KS_FAILED
HO ST _SY NC _ALL_NET WO R
KS_FINISHED
P ER SIST _HO ST _SET UP _N
ET WO R K_O N_HO ST
Erro r
10 9 0 3
P ER SIST _SET UP _NET WO R
K_O N_HO ST _FINISHED
Info
10 9 0 4
P ER SIST _SET UP _NET WO R
K_O N_HO ST _FAILED
Erro r
110 0 0
USER _AD D _EXT ER NAL_JO
B
Info
110 0 1
USER _AD D _EXT ER NAL_JO
B_FAILED
Erro r
D ata C enter
${Sto rag eP o o l Name} status
was chang ed to No n
R espo nsi ve as no ne o f i ts
ho sts are i n status UP .
Fai l ed to sync al l ho st
${Vd sName} netwo rks
Manag ed to sync al l ho st
${Vd sName} netwo rks.
(${Seq uence}/${T o tal }):
Appl yi ng netwo rk' s chang es
o n ho st ${Vd sName}. (User:
${UserName})
(${Seq uence}/${T o tal }):
Successful l y appl i ed chang es
o n ho st ${Vd sName}. (User:
${UserName})
(${Seq uence}/${T o tal }):
Fai l ed to appl y chang es o n
ho st ${Vd sName}. (User:
${UserName})
New external Jo b
${d escri pti o n} was ad d ed by
user ${UserName}
Fai l ed to ad d new external
Jo b ${d escri pti o n}
10 9 0 1
10 9 0 2
Info
Info
315
REST API ガイド
付録D タイムゾーン
D.1. タイムゾーン
API では、 仮想マシンまたは仮想マシンテンプレートのタイムゾーンを指定する際に Windows 標準形式の
タイムゾーン名は tz データベース形式にマッピングされます。 つまり、 API が受け取るのは以下に示す特
定の tz データベースコードのみになります。
表D .1 受け取ることができる t z データベースコード
t z データベース形式
Win d o ws 標準形式
Afri ca/C ai ro
Afri ca/C asabl anca
Afri ca/Jo hannesburg
Afri ca/Lag o s
Afri ca/Nai ro bi
Afri ca/R eykjavi k
Afri ca/Wi nd ho ek
Ameri ca/Ancho rag e
Ameri ca/Bo g o ta
Ameri ca/Bueno s_Ai res
Ameri ca/C aracas
Ameri ca/C hi cag o
Ameri ca/C hi huahua
Ameri ca/C hi huahua
Ameri ca/D enver
Ameri ca/G o d thab
Ameri ca/G uatemal a
Ameri ca/Hal i fax
Ameri ca/La_P az
Ameri ca/Lo s_Ang el es
Ameri ca/Manaus
Ameri ca/Mexi co _C i ty
Ameri ca/Mexi co _C i ty
Ameri ca/Mo ntevi d eo
Ameri ca/New_Y o rk
Ameri ca/P ho eni x
Ameri ca/R eg i na
Ameri ca/Santi ag o
Ameri ca/Sao _P aul o
Ameri ca/St_Jo hns
Ameri ca/T i juana
Asi a/Amman
Asi a/Bag hd ad
Asi a/Baku
Asi a/Bang ko k
Asi a/Bei rut
Asi a/C al cutta
Asi a/C o l o mbo
Eg ypt Stand ard T i me
Mo ro cco Stand ard T i me
So uth Afri ca Stand ard T i me
W. C entral Afri ca Stand ard T i me
E. Afri ca Stand ard T i me
G reenwi ch Stand ard T i me
Nami bi a Stand ard T i me
Al askan Stand ard T i me
SA P aci fi c Stand ard T i me
Arg enti na Stand ard T i me
Venezuel a Stand ard T i me
C entral Stand ard T i me
Mexi co Stand ard T i me
Mo untai n Stand ard T i me
Mo untai n Stand ard T i me
G reenl and Stand ard T i me
C entral Ameri ca Stand ard T i me
Atl anti c Stand ard T i me
SA Western Stand ard T i me
P aci fi c Stand ard T i me
C entral Brazi l i an Stand ard T i me
C entral Stand ard T i me
Mexi co Stand ard T i me
Mo ntevi d eo Stand ard T i me
Eastern Stand ard T i me
US Mo untai n Stand ard T i me
C anad a C entral Stand ard T i me
P aci fi c SA Stand ard T i me
E. So uth Ameri ca Stand ard T i me
Newfo und l and Stand ard T i me
P aci fi c Stand ard T i me
Jo rd an Stand ard T i me
Arabi c Stand ard T i me
Azerbai jan Stand ard T i me
SE Asi a Stand ard T i me
Mi d d l e East Stand ard T i me
Ind i a Stand ard T i me
Sri Lanka Stand ard T i me
316
⁠付録D タイムゾーン
t z データベース形式
Win d o ws 標準形式
Asi a/D haka
Asi a/D ubai
Asi a/Irkutsk
Asi a/Jerusal em
Asi a/Kabul
Asi a/Karachi
Asi a/Katmand u
Asi a/Krasno yarsk
Asi a/No vo si bi rsk
Asi a/R ang o o n
Asi a/R i yad h
Asi a/Seo ul
Asi a/Shang hai
Asi a/Si ng apo re
Asi a/T ai pei
Asi a/T ashkent
Asi a/T ehran
Asi a/T o kyo
Asi a/Vl ad i vo sto k
Asi a/Y akutsk
Asi a/Y ekateri nburg
Asi a/Y erevan
Asi a/Y erevan
Atl anti c/Azo res
Atl anti c/C ape_Verd e
Atl anti c/So uth_G eo rg i a
Austral i a/Ad el ai d e
Austral i a/Bri sbane
Austral i a/D arwi n
Austral i a/Ho bart
Austral i a/P erth
Austral i a/Syd ney
Etc/G MT -3
Etc/G MT + 12
Etc/G MT + 3
Etc/G MT + 5
Euro pe/Berl i n
Euro pe/Bud apest
Euro pe/Istanbul
Euro pe/Ki ev
Euro pe/Lo nd o n
Euro pe/Mi nsk
Euro pe/Mo sco w
Euro pe/P ari s
Euro pe/Warsaw
Ind i an/Mauri ti us
P aci fi c/Api a
P aci fi c/Auckl and
C entral Asi a Stand ard T i me
Arabi an Stand ard T i me
No rth Asi a East Stand ard T i me
Israel Stand ard T i me
Afg hani stan Stand ard T i me
P aki stan Stand ard T i me
Nepal Stand ard T i me
No rth Asi a Stand ard T i me
N. C entral Asi a Stand ard T i me
Myanmar Stand ard T i me
Arab Stand ard T i me
Ko rea Stand ard T i me
C hi na Stand ard T i me
Si ng apo re Stand ard T i me
T ai pei Stand ard T i me
West Asi a Stand ard T i me
Iran Stand ard T i me
T o kyo Stand ard T i me
Vl ad i vo sto k Stand ard T i me
Y akutsk Stand ard T i me
Ekateri nburg Stand ard T i me
Armeni an Stand ard T i me
C aucasus Stand ard T i me
Azo res Stand ard T i me
C ape Verd e Stand ard T i me
Mi d -Atl anti c Stand ard T i me
C en. Austral i a Stand ard T i me
E. Austral i a Stand ard T i me
AUS C entral Stand ard T i me
T asmani a Stand ard T i me
W. Austral i a Stand ard T i me
AUS Eastern Stand ard T i me
G eo rg i an Stand ard T i me
D atel i ne Stand ard T i me
SA Eastern Stand ard T i me
US Eastern Stand ard T i me
W. Euro pe Stand ard T i me
C entral Euro pe Stand ard T i me
G T B Stand ard T i me
FLE Stand ard T i me
G MT Stand ard T i me
E. Euro pe Stand ard T i me
R ussi an Stand ard T i me
R o mance Stand ard T i me
C entral Euro pean Stand ard T i me
Mauri ti us Stand ard T i me
Samo a Stand ard T i me
New Zeal and Stand ard T i me
317
REST API ガイド
t z データベース形式
Win d o ws 標準形式
P aci fi c/Fi ji
P aci fi c/G uad al canal
P aci fi c/Ho no l ul u
P aci fi c/P o rt_Mo resby
P aci fi c/T o ng atapu
Fi ji Stand ard T i me
C entral P aci fi c Stand ard T i me
Hawai i an Stand ard T i me
West P aci fi c Stand ard T i me
T o ng a Stand ard T i me
318
⁠付録E 改訂履歴
付録E 改訂履歴
改訂 3.6 - 11.1
Su n Mar 13 2016
R ed H at Lo caliz at io n
Services
翻訳ファイルを XML ソースバージョン 3.6-11 と同期
改訂 3.6 - 11
Wed 9 Mar 2016
改訂 3.6 - 10
T u e 1 Mar 2016
改訂 3.6 - 9
Mo n 22 Feb 2016
改訂 3.6 - 8
Fri 19 Feb 2016
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
BZ #1285925: OpenStack Volume (Cinder) のディスクを使用する仮想マシンのスナップショットを作成
するために必要なゲストのファイルシステムの凍結/凍結解除について内容を追加
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
BZ #1304924: ホスト毎に iSCSI の認証情報を定義する方法に関する説明を追加
BZ #1149441: ホストネットワーク API に関する内容を更新
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
Red Hat Enterprise Virtualization 3.6 の一般提供 (GA) に向けた最初の改訂
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
BZ #1309152: 仮想 CPU のホットプラグについての情報を追加
改訂 3.6 - 7
Mo n 8 Feb 2016
改訂 3.6 - 6
Fri 15 Jan 2016
改訂 3.6 - 5
T h u 14 Jan 2016
改訂 3.6 - 4
Wed 23 D ec 2015
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
BZ #1285344: ホストとストレージドメインの外部ヘルスステータスに関する情報を追加
BZ #1252755: 仮想ディスクのコピーに関する説明を追加
BZ #1285345: 複数ホストの固定に関する情報を追加
BZ #1124128: 本ガイドに NUMA についての内容を追加
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
BZ #1281667: イベントコードを記載した表に重大度およびエラーメッセージを追加
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
BZ #1284288: 「rhevm」管理ネットワークと記載されていた箇所を「ovirtmgmt」に変更
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
BZ #1194228: All-Content ヘッダーに関する情報を追加
319
REST API ガイド
改訂 3.6 - 3
Wed 18 N o v 2015
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
Red Hat Enterprise Virtualization 3.6 ベータリリースの最終版作成
改訂 3.6 - 2
Wed 18 N o v 2015
改訂 3.6 - 1
Mo n 10 Au g 2015
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
BZ #1255281: メモリーを仮想マシンにホットプラグする方法の説明を追加
BZ #1255229: 電源管理 REST API の例を更新
BZ #1250784: ストレージドメインでの「wipe after delete」のデフォルトの動作を指定する操作方法を追
加
BZ #1278783: 仮想マシンプールの作成および更新例を改訂
Red Hat Enterprise Virtualization 3.6 リリースの初版作成
320
R ed H at En t erp rise
Virt u aliz at io n
D o cu men t at io n T eam
Fly UP