Bug 1034710 - Missing documentation for "allocatevm" action in virtual machine pool REST resource
Summary: Missing documentation for "allocatevm" action in virtual machine pool REST re...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.3.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Andrew Dahms
QA Contact: Julie
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-11-26 11:36 UTC by Christophe Fergeau
Modified: 2014-08-22 06:18 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-08-22 06:18:46 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)

Description Christophe Fergeau 2013-11-26 11:36:32 UTC 
The virtual machine pools collection accessible through /api/vmpools contains vmpool resources. Each of these resource has an "allocatevm" action which can be used to 'get' a VM from a pool. Without this action, the pool is not really useful. However, this action is not documented in https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.3-Beta/html/Developer_Guide/chap-Virtual_Machine_Pools.html

Sample XML:
<vmpools>
    <vmpool href="/api/vmpools/4724e7b5-adbe-4d2c-978e-d78d4e80b63e" id="4724e7b5-adbe-4d2c-978e-d78d4e80b63e">
        <actions>
            <link href="/api/vmpools/4724e7b5-adbe-4d2c-978e-d78d4e80b63e/allocatevm" rel="allocatevm"/>
        </actions>
        <name>teuf-pool-test</name>
        <description/>
        <size>3</size>
        <cluster href="/api/clusters/99408929-82cf-4dc7-a532-9d998063fa95" id="99408929-82cf-4dc7-a532-9d998063fa95"/>
        <template href="/api/templates/f595c207-0f75-4068-9ce3-d3e58ae8ccfa" id="f595c207-0f75-4068-9ce3-d3e58ae8ccfa"/>
        <prestarted_vms>0</prestarted_vms>
    </vmpool>
</vmpools>
Comment 1 Andrew Dahms 2014-02-11 02:04:08 UTC 
Fixed in Chapter 18 topics.
Comment 2 Andrew Dahms 2014-02-17 00:23:48 UTC 
Documentation Link
------------------------------
http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.3/html-single/Developer_Guide/index.html#Virtual_Machine_Pool_Elements

What Changed
------------------------------
The following topics were revised as outlined below.

Virtual Machine Pool Elements [ 8003-588386 ]

The name, description, permissions, prestarted_vms and max_user_vms rows were added to the table.

XML Representation of a Virtual Machine Pool [ 8004-588387 ]

Added lines for the allocatevm action, prestarted_vms and max_user_vms tags.

Updating a Virtual Machine Pool [ 7778-588383 ]

Added the prestarted_vms and max_user_vms to the top paragraph and to the 'screen' section.

Added the following to outline the use of the new allocatevm action:

Allocate Virtual Machine Action [ 28498 ]

Updated revision history: [ 21132-588385 ]

NVR
------------------------------
Red_Hat_Enterprise_Virtualization-Developer_Guide-3.3-en-US-3.3-22

Moving to ON_QA.
Comment 3 Julie 2014-08-22 06:18:46 UTC 
Checked in the 3.3 release. Please open a new bug if you have further feedback.
Note You need to log in before you can comment on or make changes to this bug.