Chapter 16. Virtual Machine Pools

The 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).

The following table shows specific elements contained in a virtual machine pool resource representation.

Element property icons

The icons used in the properties column of this table are described in Table 8.1, “Element property icons”

Element	Type	Description
`name`	string	A user-supplied human readable name for the pool. The `name` is unique across all pool resources.
`description`	string	A free-form user-supplied human readable description of the pool
`size`	integer	The number of virtual machines in the pool
`cluster`	complex	A reference to the cluster resource which virtual machines in this pool run on
`template`	complex	A reference to the template resource which virtual machines in this pool are based on

Example 16.1. An XML representation of a virtual machine pool

<vmpool id="00000000-0000-0000-0000-000000000000"
  href="/rhevm-api/vmpools/00000000-0000-0000-0000-000000000000">
    <name>VMPool1</name>
    <description>Virtual Machine Pool 1</description>
    <size>2</size>
    <cluster id="99408929-82cf-4dc7-a532-9d998063fa95"
      href="/rhevm-api/clusters/99408929-82cf-4dc7-a532-9d998063fa95"/>
    <template id="00000000-0000-0000-0000-000000000000"
      href="/rhevm-api/templates/00000000-0000-0000-0000-000000000000"/>
</vmpool>