15.6. サブコレクション
15.6.1. ディスクのサブコレクション
15.6.1.1. ディスクのサブコレクション
disks
サブコレクションは、仮想マシン上のすべての仮想ハードディスクデバイスを表します。disk
表現には次のような要素が含まれます。
表15.2 仮想マシンディスクの要素
要素 | タイプ | 説明 | プロパティー |
---|---|---|---|
link rel="statistics" | リレーションシップ | 仮想マシンのディスクの統計を確認するための statistics サブコレクションへのリンク | |
link rel="permissions" | リレーションシップ | permissions サブコレクションへのリンク | |
alias | 文字列 | ディスクの一意識別子。name ではなく alias を使用します。 | |
image_id | 文字列 | 定義されたストレージドメインに格納されている仮想マシンイメージへの参照 | |
storage_domains | 複合型 | そのディスクと関連付けられたストレージドメイン。storage_domain 要素には 関連付けられたストレージドメインの GUID を示す id 属性が含まれます。データストレージドメイン間でのライブマイグレーションを実行するには、POST でこの要素を更新します。 | [a] |
size | 整数 | ディスクサイズ (バイト単位)。非推奨となり、provisioned_size に置き換えられます。 | |
provisioned_size | 整数 | プロビジョニングされたディスクのサイズ (バイト単位) | |
actual_size | 整数 | ディスクの実際のサイズ (バイト単位) | |
status | illegal 、invalid 、locked 、ok のいずれか | ディスクデバイスのステータス。 これらのステータスは capabilities の下の disk_states に記載されています。 | |
interface | 列挙型 | ディスクデバイスへの接続に使用するインターフェースドライバーのタイプ。使用できる列挙値の一覧は capabilities に記載されています。 | |
format | 列挙型 | 下層のストレージのフォーマット。列挙値の一覧は capabilities に記載されています。Copy On Write (COW) により、最小限のパフォーマンスオーバーヘッドでスナップショットを作成することができます。Raw ではスナップショットは作成できませんが、パフォーマンスが向上します。 | |
sparse | ブール値: true または false | true : 物理ストレージの場合に指定します。ディスクを事前割り当てすべきではないためです。 | |
bootable | ブール値: true または false | true : ディスクがブート可能とマークされている場合に指定します。 | |
shareable | ブール値: true または false | true : 複数の仮想マシンで共有する場合に指定します。 | |
wipe_after_delete | ブール値: true または false | true : ディスクが削除される時に下層の物理ストレージがゼロ処理される必要がある場合に指定します。これにより、セキュリティーが強化されますが、より負荷の高い操作であるため、削除に要する時間が伸びる可能性があります。 | |
propagate_errors | ブール値: true または false | true : ディスクエラーによって仮想マシンが一時停止せず、代わりにディスクエラーがゲスト OS に伝達される必要がある場合に指定します。 | |
vm id= | GUID | 格納している仮想マシンの ID | |
quota id= | GUID | ディスククォータを設定します。 | |
lun_storage | 複合型 | ストレージの使用状況を確認するための直接 LUN マッピングへの参照。iSCSI または FCP デバイスの詳細情報が含む logical_unit 要素が必要。 | |
active | ブール値 | 仮想マシンにディスクが接続されているかどうかを定義します。 | |
read_only | ブール値 | ディスクが読み取り専用かどうかを定義します。 | |
link rel="disk_profile" | リレーションシップ | disk_profile サブコレクションへのリンク | |
[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> <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>
provisioned_size
要素が必要です。storage_domains
要素を使用して、どのストレージドメインにディスクを作成するかを指定します。異なるストレージドメインには、同じ仮想マシンに対して複数のディスクを配置することができます。
例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_storage
要素と、iSCSI または FCP デバイスの詳細情報を含む logical_unit
要素が必要です。
例15.13 仮想マシン上での新規外部 LUN ディスクデバイスの作成
POST /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks HTTP/1.1 Accept: application/xml Content-type: application/xml <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>
alias
、description
、storage_domains
、provisioned_size
、interface
、bootable
、shareable
、wipe_after_delete
、propagate_errors
の要素は、作成後に更新可能です。
例15.14 仮想マシンディスクの更新
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/disks/ed7feafe-9aaf-458c-809a-ed789cdbd5b4 HTTP/1.1 Accept: application/xml Content-type: application/xml <disk> <bootable>false</bootable> <shareable>false</shareable> </disk>
例15.15 仮想マシンディスクのサイズを 20 GB に更新
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/disks/ed7feafe-9aaf-458c-809a-ed789cdbd5b4 HTTP/1.1 Accept: application/xml Content-type: application/xml <disk> <provisioned_size>21474836480</provisioned_size> </disk>
注記
例15.16 仮想マシンディスク名の変更
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/disks/ed7feafe-9aaf-458c-809a-ed789cdbd5b4 HTTP/1.1 Accept: application/xml Content-type: application/xml <disk> <alias>Classic_VM2</alias> </disk>
DELETE
要求を実行する必要があります。
例15.17 仮想マシンディスクの削除
DELETE /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/disks/ed7feafe-9aaf-458c-809a-ed789cdbd5b4 HTTP/1.1 HTTP/1.1 204 No Content
15.6.1.2. ディスクのクローン作成
clone
要素を使用します。仮想マシンの作成時に、disks
サブコレクション内の clone
要素を 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>
重要
name
ではなく alias
検索パラメーターが必要です。
15.6.1.3. ディスク統計のサブコレクション
statistics
サブコレクションを公開します。各 statistics
には次のような要素が含まれます。
表15.3 仮想マシンディスク統計の要素
要素 | タイプ | 説明 |
---|---|---|
name | 文字列 | 統計エントリーの一意識別子 |
description | 文字列 | プレーンテキストで記述された統計の説明 |
unit | 文字列 | 統計値測定の単位またはレート |
type | GAUGE または COUNTER | 統計測定値のタイプ |
values type= | INTEGER または DECIMAL | その後に続く統計値のデータタイプ |
value | 複合型 | datum を含むデータセット |
datum | values type を参照 | value に含まれるデータの 1 つ |
disk id= | リレーションシップ | 格納している disk リソースとのリレーションシップ |
表15.4 仮想マシンのディスク統計タイプ
名前
|
説明
|
---|---|
data.current.read |
ディスク読み込み時のデータ転送速度 (バイト/秒)
|
data.current.write |
ディスク書き込み時のデータ転送速度 (バイト/秒)
|
例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/ disks/f28ec14c-fc85-43e1-818d-96b49d50e27b"/> </statistic> ... </statistics>
注記
statistics
サブコレクションは読み取り専用です。
15.6.1.4. フローティングディスクのアタッチおよびデタッチのアクション
rel="disks"
コレクションからディスクをアタッチするには、仮想マシンの disks
サブコレクションに対して POST
要求を実行します。その際には、アタッチするディスクの id
を指定してください。
例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>
disks
サブコレクションからディスクをデタッチするには、ディスクリソースに対して DELETE
要求を実行します。その際には、ディスクが破棄されないように、必ず detach
のブール要素を追加してください。
例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>
15.6.1.5. ディスクのアクティブ化および非アクティブ化のアクション
activate
および deactivate
アクションセットを提供します。
例15.22 仮想マシンディスクをアクティブ化するアクション
POST /api/vms/082c794b-771f-452f-83c9-b2b5a19c0399/disks/a42ada0e-1d69-410d-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-1d69-410d-a392-a6980d873e5d/deactivate HTTP/1.1 Accept: application/xml Content-type: application/xml <action/>
重要
- Red Hat Enterprise Linux 6
- Red Hat Enterprise Linux 5
- Windows Server 2008
- Windows Server 2003
15.6.2. ネットワークインターフェースのサブコレクション
15.6.2.1. ネットワークインターフェースのサブコレクション
nics
サブコレクションは、仮想マシン上のすべてのネットワークインターフェースデバイスを表します。nics
表現には次の要素が含まれます。
表15.5 仮想マシンのネットワークインターフェースの要素
要素 | タイプ | 説明 | プロパティー |
---|---|---|---|
link rel="statistics" | リレーションシップ | 仮想マシンのネットワークインターフェース統計の statistics サブコレクションへのリンク | |
network id= | GUID | インターフェースを接続すべきネットワークへの参照。ネットワーク ID は空白にすることが可能。 | |
interface | 列挙型 | ネットワークインターフェースカードに使用するドライバーのタイプ。列挙値の一覧は capabilities にあります。 | |
mac address= | 文字列 | インターフェースの MAC アドレス | |
port_mirroring | 複合型 | NIC がミラーリングされたトラフィックを受信するかどうかを定義します。network id= 参照を使用して networks 要素を定義します。 | |
plugged | ブール値 | NIC が仮想マシンに結線されるかどうかを定義します。 | |
linked | ブール値 | 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-af44-001a4a400e0c"/> </networks> </port_mirroring> </nic>
name
および network
の要素が必要です。network
要素は id
属性または name
要素で特定します。
例15.25 仮想マシン NIC の作成
POST /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/nics HTTP/1.1 Accept: application/xml Content-type: application/xml <nic> <name>nic1</name> <network id="00000000-0000-0000-0000-000000000009"/> </nic>
PUT
要求を使用します。
例15.26 仮想マシン NIC の更新
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>
DELETE
要求で行います。
例15.27 仮想マシン NIC の削除
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
15.6.2.2. ネットワークインターフェース統計のサブコレクション
statistics
サブコレクションを公開します。各 statistic
には、次の要素が含まれます。
表15.6 仮想マシンのネットワークインターフェース統計の要素
要素 | タイプ | 説明 |
---|---|---|
name | 文字列 | 統計エントリーの一意識別子 |
description | 文字列 | プレーンテキストで記述された統計の説明 |
unit | 文字列 | 統計値測定の単位またはレート |
type | GAUGE または COUNTER | 統計測定値のタイプ |
values type= | INTEGER または DECIMAL | その後に続く統計値のデータタイプ |
value | 複合型 | datum を含むデータセット |
datum | values type を参照 | value に含まれるデータの 1 つ |
nic id= | リレーションシップ | 格納している nic リソースとのリレーションシップ |
表15.7 仮想マシンの NIC の統計タイプ
名前
|
説明
|
---|---|
data.current.rx |
データの受信速度 (ビット毎秒)
|
data.current.tx |
データの送信速度 (ビット毎秒)
|
errors.total.rx |
データ受信でのエラーの合計数
|
errors.total.tx |
データ送信でのエラーの合計数
|
例15.28 仮想マシンの NIC 統計サブコレクションの 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>
注記
statistics
サブコレクションは読み取り専用です。
15.6.3. 仮想 NUMA ノードのサブコレクション
numanodes
サブコレクションは、仮想マシン上の全仮想 NUMA ノードを表します。vm_numa_node
表現には次のような要素が含まれます。
表15.8 仮想 NUMA ノードの要素
要素 | タイプ | 説明 | プロパティー |
---|---|---|---|
index | 整数 | 仮想 NUMA ノードの指数 | |
memory | 整数 | 仮想 NUMA ノードに割り当てられたメモリーの容量 (MB 単位) | |
cpu | 複合型 | この仮想 NUMA ノードに割り当てられた CPU トポロジー。各 core の要素には、コアの指数が割り当てられた index 属性が含まれます。 | |
vm id= | GUID | 格納している仮想マシンの ID | |
numa_node_pins | 複合型 | 仮想 NUMA ノードをホストの NUMA ノードに固定します。各 numa_node_pin 要素には、pinned="true" ブール値とホストの NUMA ノードの index 数が含まれます。 |
例15.29 仮想 NUMA ノードの XML 表現
<vm_numa_node href="/api/vms/c7ecd2dc-dbd3-4419-956f-1249651c0f2b/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-87f3-dd0498fdf6c7"/> </numa_node_pin> </numa_node_pins> </vm_numa_node>
index
、memory
、cpu
の要素が必要です。
例15.30 新規 NUMA ノードの仮想マシンへの追加
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>
PUT
要求で更新します。PUT
要求を使用して、仮想 NUMA ノードをホスト上の物理 NUMA ノードに固定することができます。
例15.31 仮想 NUMA ノードの更新
PUT /api/vms/c7ecd2dc-dbd3-4419-956f-1249651c0f2b/numanodes/3290b973-ed3e-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>
DELETE
要求で仮想 NUMA ノードを削除します。
例15.32 仮想 NUMA ノードの削除
DELETE /api/vms/c7ecd2dc-dbd3-4419-956f-1249651c0f2b/numanodes/3290b973-ed3e-4f0b-bbf5-9be10d229e50 HTTP/1.1 HTTP/1.1 204 No Content
15.6.4. CD-ROM のサブコレクション
cdroms
サブコレクションは、仮想マシン上の CD-ROM デバイスを表します。cdrom
表現には次のエレメントが含まれます。
表15.9 仮想マシンの CD-ROM の要素
要素 | タイプ | 説明 | プロパティー |
---|---|---|---|
file id= | 文字列/ファイル名 | ISO イメージへの参照 |
例15.33 CD-ROM デバイスの 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>
PUT
要求を file id
要素とともに送信します。
例15.34 新規 CD-ROM ファイルの追加
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-0000-0000-0000-000000000000 HTTP/1.1 Accept: application/xml Content-type: application/xml <cdrom> <file id="fedora-15-x86_64-dvd.iso"/> </cdrom>
PUT
要求を使用して CD-ROM を変更します。
例15.35 CD-ROM ファイルの変更
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-0000-0000-0000-000000000000 HTTP/1.1 Accept: application/xml Content-type: application/xml <cdrom> <file id="fedora-15-x86_64-dvd.iso"/> </cdrom>
PUT
要求に current
URI 引数を追加して使用すると、API は現行セッションの CD-ROM を変更します。
例15.36 現行セッション中の CD-ROM ファイル変更
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-0000-0000-0000-000000000000;current=true HTTP/1.1 Accept: application/xml Content-type: application/xml <cdrom> <file id="fedora-15-x86_64-dvd.iso"/> </cdrom>
cdroms
サブコレクションに PUT
要求を送信して、current=true
マトリックスパラメーターを追加します。
例15.37 現行セッション中の CD-ROM ファイルの取り出し
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-0000-0000-0000-000000000000;current=true HTTP/1.1 Accept: application/xml Content-type: application/xml <cdrom> <file id=""/> </cdrom>
注記
cdroms
サブコレクションに PUT
要求を送信します。
例15.38 CD-ROM ファイルの完全取り出し
PUT /api/vms/cdc0b102-fbfe-444a-b9cb-57d2af94f401/cdroms/00000000-0000-0000-0000-000000000000 HTTP/1.1 Accept: application/xml Content-type: application/xml <cdrom> <file id=""/> </cdrom>
注記
15.6.5. スナップショットのサブコレクション
15.6.5.1. スナップショットのサブコレクション
rel="snapshot"
サブコレクションで表現/管理されます。このサブコレクションは、他のコレクションと同様に動作します。
snapshot
要素で表されます。
表15.10 仮想マシンのスナップショットの要素
要素 | タイプ | 説明 | プロパティー |
---|---|---|---|
vm id= | GUID | そのスナップショットの作成元である仮想マシンの ID と URI | |
link rel="restore" | リレーションシップ | その仮想マシンのスナップショットを復元するためののリンク | |
link rel="prev" | リレーションシップ | その仮想マシンの前のスナップショットへのリンク | |
type | 文字列 | active または regular などのスナップショットの種類 | |
date | xsd:dateTime の形式: YYYY-MM-DDThh:mm:ss | そのスナップショットが作成された日付と時刻 | |
snapshot_status | 文字列 | スナップショットの現在のステータス | |
persist_memorystate | ブール値 | スナップショットを作成する際の仮想マシンメモリーのステータスをスナップショットに含めるかどうかを定義します。 |
注記
PUT
を使用できません。
例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>
GET
要求で All-Content: true
ヘッダーを使用して、スナップショットの表現に追加の OVF データを含めます。
Accept
ヘッダーを空欄にした場合には、デフォルトで application/xml
となり、XML タグに影響しないようにデータは HTML エンティティーで表現されます。Accept: application/json
ヘッダーを指定すると、データは標準の XML タグで返されます。以下の表現の例は、標準のブロックフォーマットを編集して、より読みやすい書式で示しています。
例15.40 スナップショットの追加の OVF データの 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/cim-schema/2/CIM_ResourceAllocationSettingData\" xmlns:vssd=\"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ovf:version=\"3.5.0.0\"> <References> <File ovf:href=\"ad353554-f668-46cf-aa3c-e57383de2c92/40456d92-3687-4a85-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-3687-4a85-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> <DeleteProtected>false</DeleteProtected> <SsoMethod>guest_agent</SsoMethod> <IsSmartcardEnabled>false</IsSmartcardEnabled> <TimeZone>Etc/GMT</TimeZone><default_boot_sequence>0</default_boot_sequence> <Generation>1</Generation> <VmType>1</VmType> <MinAllocatedMem>1024</MinAllocatedMem> <IsStateless>false</IsStateless> <IsRunAndPause>false</IsRunAndPause> <AutoStartup>false</AutoStartup> <Priority>1</Priority> <CreatedByUserId>fdfc627c-d875-11e0-90f0-83df133b58cc</CreatedByUserId> <IsBootMenuEnabled>false</IsBootMenuEnabled> <IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled> <IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled> <Name>VM_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-0000-000000000000</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> <rasd:InstanceId>40456d92-3687-4a85-bab3-87b4cc7af459</rasd:InstanceId> <rasd:ResourceType>17</rasd:ResourceType> <rasd:HostResource>ad353554-f668-46cf-aa3c-e57383de2c92/40456d92-3687-4a85-bab3-87b4cc7af459</rasd:HostResource> <rasd:Parent>00000000-0000-0000-0000-000000000000</rasd:Parent> <rasd:Template>00000000-0000-0000-0000-000000000000</rasd:Template> <rasd:ApplicationList></rasd:ApplicationList> <rasd:StoragePoolId>00000002-0002-0002-0002-000000000255</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-ba02-c6dfa7fc707c</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-9b53-dee6dee41cfd</rasd:InstanceId> <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-beee-520bdfd9c698</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-82bb-41d91e46fd36</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-9331-64b5d8cebe2e</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> <rasd:ResourceType>0</rasd:ResourceType> <rasd:InstanceId>2f4f8aa5-25eb-4a31-b841-50dc48fce4a7</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-ae77-cc98f8b45bd8</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-8b6e-46aef9798d84</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-88f5-6a48f14164e1</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-a544-d537c87e82df</rasd:InstanceId> <Type>controller</Type> <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-bd12-50ce4e1ce379</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>
POST
メソッドを使用して実行中の仮想マシンのスナップショットを作成したり (ライブスナップショット)、シャットダウンしたりできます。
例15.41 仮想マシンのスナップショットの作成
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>
重要
rel="restore"
アクションリンクを使用して、仮想マシンのスナップショットを復元することができます。
例15.42 仮想マシンのスナップショットの復元
POST /api/vms/00000000-0000-0000-0000-000000000000/snapshots/00000000-0000-0000-0000-000000000000/restore HTTP/1.1 Accept: application/xml Content-type: application/xml <action/>
15.6.5.2. スナップショットから仮想マシンのクローンを作成します。
snapshots
要素を追加する必要があります。ユーザーはこの要素を POST
要求で vms
コレクションに送信します。
snapshots
要素には、仮想マシンのベースとして使用する特定のスナップショットを定義する snapshot id=
要素が含まれます。
例15.43 スナップショットからの仮想マシンのクローン作成
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. 統計のサブコレクション
statistics
サブコレクションを公開します。各 statistic
には次の要素が含まれます。
表15.11 仮想マシン統計の要素
要素 | タイプ | 説明 |
---|---|---|
name | 文字列 | 統計エントリーの一意識別子 |
description | 文字列 | プレーンテキストで記述された統計の説明 |
unit | 文字列 | 統計値測定の単位またはレート |
type | GAUGE または COUNTER | 統計測定値のタイプ |
values type= | INTEGER または DECIMAL | その後に続く統計値のデータタイプ |
value | 複合型 | datum を含むデータセット |
datum | values type を参照 | value に含まれるデータの 1 つ |
vm id= | リレーションシップ | 格納している vm リソースとのリレーションシップ |
表15.12 仮想マシンの統計タイプ
名前
|
説明
|
---|---|
memory.installed |
仮想マシンが使用するために割り当てられたメモリー合計 (バイト単位)
|
memory.used |
仮想マシンが現在使用中のメモリー (バイト単位)
|
cpu.current.guest |
ゲストの CPU 使用率
|
cpu.current.hypervisor |
Hypervisor 上の CPU オーバーヘッド (%)
|
cpu.current.total |
現在の CPU 使用率合計
|
例15.44 仮想マシンの統計サブコレクションの 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>
注記
statistics
サブコレクションは読み取り専用です。
15.6.7. 仮想マシンのセッション情報の表示
GET
要求を送信し、session
サブコレクションを使用して、SPICE コンソールセッションを開始したユーザーと、仮想マシンにログインしたユーザーのセッション情報を表示します。
session
の情報は、サブコレクションとして表示されます。
例15.45 仮想マシンのセッション情報の表示
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-af17-158be31489b3/sessions/37a6259c-c0c1-dae2-99a7-866489dff0bd"> <vm href= "/api/vms/a1a701f1-aa06-4f02-af17-158be31489b3" id="a1a701f1-aa06-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-af17-158be31489b3/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>