Package org.ovirt.engine.sdk4.services

Interface VmService.GetRequest

    • Method Detail

      • allContent

        VmService.GetRequest allContent​(Boolean allContent)
        Indicates if all of the attributes of the virtual machine should be included in the response. By default the following attributes are excluded: - `console` - `initialization.configuration.data` - The OVF document describing the virtual machine. - `rng_source` - `soundcard` - `virtio_scsi` For example, to retrieve the complete representation of the virtual machine '123': .... GET /ovirt-engine/api/vms/123?all_content=true .... NOTE: These attributes are not included by default as they reduce performance. These attributes are seldom used and require additional queries to the database. Only use this parameter when required as it will reduce performance.

      • filter

        VmService.GetRequest filter​(Boolean filter)
        Indicates if the results should be filtered according to the permissions of the user.

      • follow

        VmService.GetRequest follow​(String follow)
        Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part of the current request. See <> for details.

      • nextRun

        VmService.GetRequest nextRun​(Boolean nextRun)
        Indicates if the returned result describes the virtual machine as it is currently running or if describes the virtual machine with the modifications that have already been performed but that will only come into effect when the virtual machine is restarted. By default the value is `false`. If the parameter is included in the request, but without a value, it is assumed that the value is `true`. The the following request: [source] ---- GET /vms/{vm:id};next_run ---- Is equivalent to using the value `true`: [source] ---- GET /vms/{vm:id};next_run=true ----

      • ovfAsOva

        VmService.GetRequest ovfAsOva​(Boolean ovfAsOva)
        Indicates if the results should expose the OVF as it appears in OVA files of that VM. The OVF document describing the virtual machine. This parameter will work only when all_content=True is set. The OVF will be presented in `initialization.configuration.data`. For example: [source] ---- GET /vms/{vm:id}?all_content=true&ovf_as_ova=true ----