14.7. サブコレクション
14.7.1. ホストのネットワークアタッチメントのサブコレクション リンクのコピーリンクがクリップボードにコピーされました!
network_attachments サブコレクションは、ホストのネットワーク設定を表現します。各 network_attachment 要素は、ホストにアタッチされたネットワークを表現しており、この要素には以下の要素が含まれます。
|
要素
|
タイプ
|
説明
|
プロパティー
|
|---|---|---|---|
network id=
|
GUID
|
ホストがアタッチされたネットワークへの参照
|
|
host_nic id=
|
GUID
|
ネットワークがアタッチされるホストネットワークインターフェースへの参照
|
|
ip_address_assignments
|
複合型
|
ネットワークの IP 設定。各
ip_address_assignment には、assignment_method と ip address= netmask= gateway= サブ要素が含まれています。
| |
properties
|
複合型
|
ネットワークのカスタムプロパティーキーを定義します。各
property には name および value のサブ要素が含まれます。「ネットワークアタッチメントのカスタムプロパティー」を参照してください。
| |
reported_configurations
|
複合型
|
読み取り専用のネットワークアタッチメントの設定プロパティー一覧。ネットワークアタッチメントがデータセンターの論理ネットワーク定義と同期されてない場合には、
in_sync ブール値は false です。各 reported_configuration には name、expected_value、actual_value、in_sync サブ要素が含まれます。
|
|
host id=
|
GUID
|
ホストへの参照
|
|
例14.9 ホスト上のネットワークアタッチメントの XML 表現
id または name を指定した network と host_nic 要素が必要です。host_nic ID は、未使用のネットワークインターフェースカードまたはボンぢングのいずれかを参照することができます。
例14.10 ホストへのネットワークのアタッチ
host_nic、ip_address_assignments、properties 要素は、作成後に更新可能です。host_nic ID を変更すると、ネットワークが別のネットワークインターフェースカードに移動されます。
例14.11 ホストネットワークのアタッチメントの変更
DELETE 要求を使用して、ホストからネットワークをデタッチします。
例14.12 ホストからのネットワークのデタッチ
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000/networkattachments/00000000-0000-0000-0000-000000000000 HTTP/1.1 Accept: application/xml Content-type: application/xml HTTP/1.1 204 No Content
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000/networkattachments/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
HTTP/1.1 204 No Content
重要
14.7.2. ホストのネットワークインターフェースのサブコレクション リンクのコピーリンクがクリップボードにコピーされました!
14.7.2.1. ホストのネットワークインターフェースのサブコレクション リンクのコピーリンクがクリップボードにコピーされました!
nics サブコレクションは、ホストの物理ネットワークインターフェースを表します。GET 要求に関する追加の情報は、All-Content: true ヘッダーを使用して取得することができます。表現内の各 host_nic 要素はネットワークインターフェースとして機能し、次の要素を含みます。
| 要素 | タイプ | 説明 | プロパティー |
|---|---|---|---|
name | 文字列 | ホストのネットワークインターフェース名 (例: eth0) |
[a]
|
link rel="statistics" | リレーションシップ | ホストのネットワークインターフェース統計の statistics サブコレクションへのリンク |
|
link rel="labels" | リレーションシップ | ホストのネットワークインターフェースラベルの labels サブコレクションへのリンク | |
link rel="networkattachments" | リレーションシップ | ホストのネットワークインターフェース設定の networkattachments サブコレクションへのリンク | |
link rel="master" | リレーションシップ | スレーブインターフェースである場合は、マスターのボンディングインターフェースへの参照 |
|
host id= | GUID | ホストへの参照 |
|
network id= | GUID | インターフェースがアタッチされたネットワークがある場合は、そのネットワークへの参照 |
[b] |
mac address= | 文字列 | インターフェースの MAC アドレス |
|
ip address= netmask= gateway= mtu= | 複合型 | インターフェースの IP レベルの設定 | |
mtu | 複合型 | インターフェースの最大伝送単位 | |
boot_protocol | 列挙型 | ホスト起動時の IP アドレス割り当てのプロトコル。列挙値の一覧は capabilities に記載されています。 | |
status | 列挙型 | ネットワークインターフェースのリンクステータス。これらのステータスは capabilities の下の host_nic_states に記載されています。 |
|
vlan id | 整数 | このインターフェースが表している VLAN |
|
bonding | 複合型 | ボンディングインターフェースの options と slave の各 NIC の一覧 |
[c]
|
bridged | ブール値 | ネットワークのブリッジングステータスを定義します。ブリッジされたネットワークの場合は true に、ブリッジされていないネットワークの場合は false に設定します。 | |
[a]
ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追加することはできません。
[b]
ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追加することはできません。
[c]
ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追加することはできません。
| |||
例14.13 ホスト上のネットワークインターフェースの XML 表現
network、ip、boot_protocol の要素が含まれます。
PUT 要求を使用してネットワークインターフェースを変更します。
DELETE 要求でネットワークインターフェースを削除します。
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/ 00000000-0000-0000-0000-000000000000 HTTP/1.1 HTTP/1.1 204 No Content
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/
00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
14.7.2.2. ボンディングインターフェース リンクのコピーリンクがクリップボードにコピーされました!
bonding 要素を含む host_nic のリソースとして表します。
| 要素 | タイプ | 説明 | プロパティー |
|---|---|---|---|
options | 複合型 | ボンディングインターフェースの option 要素の一覧。各 option にはプロパティーの name と value の属性が含まれます。 |
[a]
|
slaves | 複合型 | ボンディングインターフェースのスレーブ host_nic id= 要素の一覧 |
[b]
|
[a]
ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追加することはできません。
[b]
ボンディングインターフェースを追加する場合にのみ必要。その他のインターフェースは読み取り専用で、追加することはできません。
| |||
host_nic (POST) の作成時、または host_nic (PUT) の更新時に新しいボンディングを作成します。id または name 要素のいずれかを使用して、スレーブ host_nic 要素を特定します。新しいネットワークインターフェースを追加するには、name と network 要素が必要です。id 属性または name 要素で network 要素を特定します。
例14.14 ボンディングインターフェースの作成
重要
bond0、bond1、bond2, bond3、bond4 のみです。
例14.15 ボンディングインターフェースの削除
DELETE 要求でボンディングインターフェースを削除します。
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000 HTTP/1.1 HTTP/1.1 204 No Content
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
重要
14.7.2.3. ネットワークインターフェースのネットワークアタッチメント リンクのコピーリンクがクリップボードにコピーされました!
14.7.2.3.1. ネットワークインターフェースのネットワークアタッチメント リンクのコピーリンクがクリップボードにコピーされました!
network_attachments サブコレクションを公開します。各 network_attachment は、ネットワークインターフェースにアタッチされるネットワークを表現しており、このサブコレクションには以下の要素が含まれます。
|
要素
|
タイプ
|
説明
|
プロパティー
|
|---|---|---|---|
network id=
|
GUID
|
インターフェースがアタッチされたネットワークへの参照
|
|
host_nic id=
|
GUID
|
ホストのネットワークインターフェースへの参照
|
|
ip_address_assignments
|
複合型
|
ネットワークの IP 設定。各
ip_address_assignment には、assignment_method と ip address= netmask= gateway= サブ要素が含まれています。
| |
properties
|
複合型
|
ネットワークのカスタムプロパティーキーを定義します。各
property には name および value のサブ要素が含まれます。
| |
reported_configurations
|
複合型
|
読み取り専用のネットワークアタッチメントの設定プロパティー一覧。ネットワークアタッチメントにコミットされていないネットワーク設定が含まれている場合には、
in_sync ブール値は false です。各 reported_configuration には name、expected_value、actual_value、in_sync サブ要素が含まれます。
|
|
例14.16 ネットワークインターフェースカードのネットワークアタッチメントのXML 表現
id または name のいずれかと、network 要素が必要です。
例14.17 ホストのネットワークインターフェースカードに対するネットワークのアタッチ
ip_address_assignments と properties 要素は、作成後に更新可能です。
例14.18 ネットワークアタッチメントの変更
DELETE 要求を使用して、ネットワークインターフェースからネットワークをデタッチします。
例14.19 ホストネットワークインターフェースカードからのネットワークのデタッチ
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000/networkattachments/00000000-0000-0000-0000-000000000000 HTTP/1.1 Accept: application/xml Content-type: application/xml HTTP/1.1 204 No Content
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000/networkattachments/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
HTTP/1.1 204 No Content
重要
14.7.2.3.2. ネットワークアタッチメントのカスタムプロパティー リンクのコピーリンクがクリップボードにコピーされました!
name と value のサブ要素が含まれます。カスタムプロパティーを変更するには、ネットワークアタッチメントに対して PUT 要求を実行するか、setupnetworks アクションを使用して POST 要求を実行してください。
| 要素 | タイプ | 説明 |
|---|---|---|
name | 文字列 | プロパティーの一意識別子。ブリッジオプションには、bridge_opts というセット名があります。 |
value | 文字列 | 有効なキーと値を「[key]=[value]」の構文で示すブリッジオプション。エントリーが複数ある場合には、空白文字で区切ります。有効なキーは以下のようになります。値は例として示しています。
|
例14.20 ネットワークアタッチメントのプロパティーサブコレクションの XML 表現
14.7.2.4. ネットワークインターフェースのラベル リンクのコピーリンクがクリップボードにコピーされました!
例14.21 ネットワークインターフェースカードへのラベルのアタッチ
POST /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000/labels HTTP/1.1 Accept: application/xml Content-type: application/xml <label id="Label_001" />
POST /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000/labels HTTP/1.1
Accept: application/xml
Content-type: application/xml
<label id="Label_001" />
DELETE 要求が必要です。
例14.22 ネットワークインターフェースカードからのラベルの削除
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000 HTTP/1.1 HTTP/1.1 204 No Content
DELETE /api/hosts/00000000-0000-0000-0000-000000000000/nics/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000 HTTP/1.1
HTTP/1.1 204 No Content
14.7.2.5. ネットワークインターフェースの統計 リンクのコピーリンクがクリップボードにコピーされました!
statistics サブコレクションを公開します。各 statistic には、次のような要素が含まれます。
| 要素 | タイプ | 説明 |
|---|---|---|
name | 文字列 | 統計エントリーの一意識別子 |
description | 文字列 | プレーンテキストで記述された統計の説明 |
unit | 文字列 | 統計値測定の単位またはレート |
type | GAUGE または COUNTER | 統計測定値のタイプ |
values type= | INTEGER または DECIMAL | その後に続く統計値のデータタイプ |
value | 複合型 | datum を含むデータセット |
datum | values type を参照 | value に含まれるデータの 1 つ |
host_nic id= | リレーションシップ | 格納している host_nic リソースとのリレーションシップ |
|
名前
|
説明
|
|---|---|
data.current.rx |
データの受信速度 (ビット毎秒)
|
data.current.tx |
データの送信速度 (ビット毎秒)
|
data.total.rx |
合計受信データ
|
data.total.tx |
合計送信データ
|
errors.total.rx |
データ受信でのエラーの合計数
|
errors.total.tx |
データ送信でのエラーの合計数
|
例14.23 ホストのネットワークインターフェース統計サブコレクションの XML 表現
注記
statistics サブコレクションは読み取り専用です。
14.7.3. ストレージのサブコレクション リンクのコピーリンクがクリップボードにコピーされました!
storage サブコレクションは、ホストで使用可能な iSCSI および FCP ストレージの表現の一覧を提供します。このストレージは、ストレージドメインを作成する際に使用します。
storage の表現は SCSI LUN を表します。
例14.24 ホスト上のストレージサブコレクションの XML 表現
注記
host_storage コレクションは読み取り専用です。
重要
14.7.4. ホスト NUMA ノードのサブコレクション リンクのコピーリンクがクリップボードにコピーされました!
14.7.4.1. NUMA ノードのサブコレクション リンクのコピーリンクがクリップボードにコピーされました!
numanodes サブコレクションは、ホストの NUMA トポロジーを表現します。サブコレクションの各 host_numa_node 要素は、NUMA ノードを表現します。
例14.25 ホスト上にある NUMA ノードのサブコレクションの XML 表現
注記
host_numa_nodes サブコレクションは読み取り専用です。
14.7.4.2. NUMA ノードの統計 リンクのコピーリンクがクリップボードにコピーされました!
statistics サブコレクションを公開します。各 statistics には、次のような要素が含まれます。
| 要素 | タイプ | 説明 |
|---|---|---|
name | 文字列 | 統計エントリーの一意識別子 |
description | 文字列 | プレーンテキストで記述された統計の説明 |
unit | 文字列 | 統計値測定の単位またはレート |
type | GAUGE または COUNTER | 統計測定値のタイプ |
values type= | INTEGER または DECIMAL | その後に続く統計値のデータタイプ |
value | 複合型 | datum を含むデータセット |
datum | values type を参照 | value に含まれるデータの 1 つ |
host_numa_node id= | リレーションシップ | 格納している vm リソースとのリレーションシップ |
| 名前 | 説明 |
|---|---|
memory.total | ホスト上のメモリー合計 (バイト単位) |
memory.used | NUMA ノード上の使用メモリー容量 (バイト単位) |
memory.free | NUMA ノード上の空きメモリー容量 (バイト単位) |
cpu.current.user | ユーザーの CPU 使用率 |
cpu.current.system | システムの CPU 使用率 |
cpu.current.idle | アイドル時の CPU 使用率 |
例14.26 ホスト NUMA ノードの統計サブコレクションの XML 表現
注記
statistics サブコレクションは読み取り専用です。
14.7.5. ホスト統計のサブコレクション リンクのコピーリンクがクリップボードにコピーされました!
14.7.5.1. ホスト統計のサブコレクション リンクのコピーリンクがクリップボードにコピーされました!
statistics サブコレクションを公開します。各 statistics には、次のような要素が含まれます。
| 要素 | タイプ | 説明 |
|---|---|---|
name | 文字列 | 統計エントリーの一意識別子 |
description | 文字列 | プレーンテキストで記述された統計の説明 |
unit | 文字列 | 統計値測定の単位またはレート |
type | GAUGE または COUNTER | 統計測定値のタイプ |
values type= | INTEGER または DECIMAL | その後に続く統計値のデータタイプ |
value | 複合型 | datum を含むデータセット |
datum | values type を参照 | value に含まれるデータの 1 つ |
host id= | リレーションシップ | 格納している host リソースとのリレーションシップ |
|
名前
|
説明
|
|---|---|
memory.total |
ホスト上のメモリー合計 (バイト単位)
|
memory.used |
ホスト上の使用メモリー容量 (バイト単位)
|
memory.free |
ホスト上の空きメモリー容量 (バイト単位)
|
memory.shared |
ホストで共有されるメモリー容量 (バイト単位)
|
memory.buffers |
I/O バッファー (バイト単位)
|
memory.cached |
OS キャッシュ (バイト単位)
|
swap.total |
ホスト上の swap メモリー容量 (バイト単位)
|
swap.free |
ホスト上の空き swap メモリー容量 (バイト単位)
|
swap.used |
ホスト上の使用 swap メモリー容量 (バイト単位)
|
swap.cached |
ホストのメモリー内にもキャッシュされている swap メモリー容量 (バイト単位)
|
ksm.cpu.current |
Kernel SamePage Merging (KSM) の CPU 使用率
|
cpu.current.user |
ユーザーの CPU 使用率
|
cpu.current.system |
システムの CPU 使用率
|
cpu.current.idle |
アイドル時の CPU 使用率
|
cpu.load.avg.5m |
5 分あたりの CPU 負荷平均
|
例14.27 ホストの統計サブコレクションの XML 表現
注記
statistics サブコレクションは読み取り専用です。


