Package org.ovirt.engine.sdk4.services

Interface VmPoolService

All Superinterfaces:

Service

All Known Implementing Classes:

VmPoolServiceImpl

public interface VmPoolService
extends Service

A service to manage a virtual machines pool.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	VmPoolService.AllocateVmRequest	This operation allocates a virtual machine in the virtual machine pool.
static interface	VmPoolService.AllocateVmResponse	This operation allocates a virtual machine in the virtual machine pool.
static interface	VmPoolService.GetRequest	Get the virtual machine pool.
static interface	VmPoolService.GetResponse	Get the virtual machine pool.
static interface	VmPoolService.RemoveRequest	Removes a virtual machine pool.
static interface	VmPoolService.RemoveResponse	Removes a virtual machine pool.
static interface	VmPoolService.UpdateRequest	Update the virtual machine pool.
static interface	VmPoolService.UpdateResponse	Update the virtual machine pool.

Method Summary

Modifier and Type	Method	Description
VmPoolService.AllocateVmRequest	allocateVm()	This operation allocates a virtual machine in the virtual machine pool.
VmPoolService.GetRequest	get()	Get the virtual machine pool.
AssignedPermissionsService	permissionsService()	Reference to a service managing the virtual machine pool assigned permissions.
VmPoolService.RemoveRequest	remove()	Removes a virtual machine pool.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.
VmPoolService.UpdateRequest	update()	Update the virtual machine pool.

Method Detail

allocateVm

VmPoolService.AllocateVmRequest allocateVm()

This operation allocates a virtual machine in the virtual machine pool. [source] ---- POST /ovirt-engine/api/vmpools/123/allocatevm ---- The allocate virtual machine action does not take any action specific parameters, so the request body should contain an empty `action`: [source,xml] ---- ----

get

VmPoolService.GetRequest get()

Get the virtual machine pool. [source] ---- GET /ovirt-engine/api/vmpools/123 ---- You will get a XML response like that one: [source,xml] ---- ... MyVmPool MyVmPool description 1 0 100 false automatic false