Bug 1034710 – Missing documentation for "allocatevm" action in virtual machine pool REST resource

Bugzilla will be upgraded to version 5.0. The upgrade date is tentatively scheduled for 2 December 2018, pending final testing and feedback.

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

Status:	CLOSED CURRENTRELEASE

Aliases:	None

Product:	Red Hat Enterprise Virtualization Manager
Classification:	Red Hat
Component:	Documentation (Show other bugs)
Sub Component:
Version:	3.3.0
Hardware:	Unspecified Unspecified

Priority	unspecified Severity unspecified
Target Milestone:	---
Target Release:	---
Assigned To:	Andrew Dahms
QA Contact:	Julie
Docs Contact:

URL:
Whiteboard:
Keywords:

Depends On:
Blocks:
	Show dependency tree / graph

Reported:	2013-11-26 06:36 EST by Christophe Fergeau
Modified:	2014-08-22 02:18 EDT (History)
CC List:	5 users (show)

See Also:
Fixed In Version:
Doc Type:	Bug Fix
Doc Text:
Story Points:	---
Clone Of:
Environment:
Last Closed:	2014-08-22 02:18:46 EDT
Type:	Bug
Regression:	---
Mount Type:	---
Documentation:	---
CRM:
Verified Versions:
Category:	---
oVirt Team:	---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---

Attachments	(Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

Groups: None (edit)

Description Christophe Fergeau 2013-11-26 06:36:32 EST

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-10 21:04:08 EST

Fixed in Chapter 18 topics.

Comment 2 Andrew Dahms 2014-02-16 19:23:48 EST

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 02:18:46 EDT

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.