org.ovirt.engine.sdk4.services

Interface VmService.GetRequest

All Superinterfaces:

Request<VmService.GetRequest,VmService.GetResponse>

Enclosing interface:

VmService

public static interface VmService.GetRequest
extends Request<VmService.GetRequest,VmService.GetResponse>

Retrieves the description of the virtual machine.

Note that some elements of the description of the virtual machine won’t be returned unless the All-Content header is present in the request and has the value true. The elements that aren’t currently returned are the following:

• console

• initialization.configuration.data - The OVF document describing the virtual machine.

• rng_source

• soundcard

• virtio_scsi

With the Python SDK the All-Content header can be set using the all_content parameter of the get method:

api.vms.get(name="myvm", all_content=True)

Note that the reason for not including these elements is performance: they are seldom used and they require additional queries in the server. So try to use the All-Content header only when it is really needed.

Method Summary

Modifier and Type	Method and Description
VmService.GetRequest	filter(Boolean filter) Indicates if the results should be filtered according to the permissions of the user.
VmService.GetRequest	nextRun(Boolean nextRun) Indicates if the returned result describes the virtual machine as it is currently running, or if describes it with the modifications that have already been performed but that will have effect only when it is restarted.

Methods inherited from interface org.ovirt.engine.sdk4.Request

send

Method Detail

filter

VmService.GetRequest filter(Boolean filter)

Indicates if the results should be filtered according to the permissions of the user.

nextRun

VmService.GetRequest nextRun(Boolean nextRun)

Indicates if the returned result describes the virtual machine as it is currently running, or if describes it with the modifications that have already been performed but that will have effect only when it is restarted. By default the values is false.

If the parameter is included in the request, but without a value, it is assumed that the value is true, so the following request:

GET /vms/{vm:id};next_run

Is equivalent to using the value true:

GET /vms/{vm:id};next_run=true