vmpools
collection provides information about the virtual machine pools in a Red Hat Enterprise Virtualization environment. An API user accesses this information through the rel="vmpools"
link obtained from the entry point URI (see Chapter 4, Entry Point).
Element | Type | Description | Properties |
---|---|---|---|
size
| integer | The number of virtual machines in the pool. | |
cluster id=
| GUID | A reference to the cluster resource which virtual machines in this pool run. |
![]() ![]() |
template id=
| GUID | A reference to the template resource which virtual machines in this pool are based. |
![]() ![]() |
<vmpool id="3t6y18o-44u3-e7h7-56j7-3k5d8g9w0t" href="/api/vmpools/3t6y18o-44u3-e7h7-56j7-3k5d8g9w0t"> <name>VMPool1</name> <description>Virtual Machine Pool 1</description> <size>2</size> <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"/> </vmpool>
name
, cluster
and template
elements. Identify the cluster
and template
with the id
attribute or name
element. See Section 7.2.4, “ Creating a Resource in a Collection ” for more information.
POST /api/vmpools HTTP/1.1 Accept: application/xml Content-type: application/xml <vmpool> <name>VM Pool A</name> <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"/> </vmpool>
name
, description
and size
are updatable post-creation. See Section 7.3.2, “ Updating a Resource ” for more information.
PUT /api/vmpools/3t6y18o-44u3-e7h7-56j7-3k5d8g9w0t HTTP/1.1 Accept: application/xml Content-type: application/xml <vmpool> <name>VM Pool B</name> <description>Virtual Machine Pool B</description> <size>3</size> </vmpool>
DELETE
request.
DELETE /api/vmpools/3t6y18o-44u3-e7h7-56j7-3k5d8g9w0t HTTP/1.1 HTTP/1.1 204 No Content