Package org.ovirt.engine.sdk4.services

Interface VmGraphicsConsolesService.ListRequest

  • All Superinterfaces:
    Request<VmGraphicsConsolesService.ListRequest,​VmGraphicsConsolesService.ListResponse>
    Enclosing interface:
    VmGraphicsConsolesService
    public static interface VmGraphicsConsolesService.ListRequest
extends Request<VmGraphicsConsolesService.ListRequest,​VmGraphicsConsolesService.ListResponse>
    Lists all the configured graphics consoles of the virtual machine. IMPORTANT: By default, when the `current` parameter is not specified, the data returned corresponds to the next execution of the virtual machine. In the current implementation of the system this means that the `address` and `port` attributes will not be populated because the system does not know what address and port will be used for the next execution. Since in most cases those attributes are needed, it is strongly advised to aways explicitly include the `current` parameter with the value `true`. The order of the returned list of graphics consoles is not guaranteed.

    • Method Detail

      • current

        VmGraphicsConsolesService.ListRequest current​(Boolean current)
        Specifies if the data returned should correspond to the next execution of the virtual machine, or to the current execution. IMPORTANT: The `address` and `port` attributes will not be populated unless the value is `true`. For example, to get data for the current execution of the virtual machine, including the `address` and `port` attributes, send a request like this: [source] ---- GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true ---- The default value is `false`.

      • follow

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