Much of this developer documentation provides historical context but may not reflect the current state of the project.
If you see outdated content please navigate to the page footer and click "Report an issue on GitHub".

It is not user documentation and should not be treated as such.

User Documentation is available here.

Vm Parameters in REST API for Vm Pools


Add VM parameters to VmPool collection in REST API. Currently a majority of the parameters available in the UI are missing from VmPool collection in REST API.


Detailed Description

The problem is described in Bug 1195167.

Currently a majority of VM parameters that are available in the UI when adding VM Pool are missing from REST API VmPool collection. The parameters available for VmPool are:

  • vmpool.comment
  • vmpool.size
  • vmpool.max_user_vms
  • vmpool.display.proxy
  • vmpool.description

That means that VM parameters are inherited from the template used and there is no way to override them on VmPool level. In contrary, WebAdmin UI has this feature.

The proposal is to add new <vm> subelement with all the VM fields into the <vmpool> element. The values of these fields will override the values of the corresponding template parameters. The structure will be as follows:

 <template id="xxx"/>
  <some_overriden_field_a>new value</some_overriden_field_a>
  <some_overriden_field_b>new value 2</some_overriden_field_b>