services.VmGraphicsConsoleService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Show all versions of model Show documentation
Model management tools for the oVirt Engine API.
/*
Copyright (c) 2015 Red Hat, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package services;
import annotations.Area;
import mixins.Follow;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.GraphicsConsole;
@Service
@Area("Virtualization")
public interface VmGraphicsConsoleService {
/**
* Retrieves the graphics console configuration 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`.
*
* @author Tomas Jelinek
* @author Juan Hernandez
* @author Tahlia Richardson
* @date 25 Jul 2017
* @status updated_by_docs
*/
interface Get extends Follow {
/**
* The information about the graphics console of the virtual machine.
*
* @author Ondra Machacek
* @date 31 Oct 2016
* @status added
*/
@Out GraphicsConsole console();
/**
* 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 /ovit-engine/api/vms/123/graphicsconsoles/456?current=true
* ----
*
* The default value is `false`.
*
* @author Tomas Jelinek
* @author Juan Hernandez
* @author Tahlia Richardson
* @date 25 Jul 2017
* @status updated_by_docs
*/
@In Boolean current();
}
interface ProxyTicket {
@Out ProxyTicket proxyTicket();
/**
* Indicates if the generation of the ticket should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Generates a time-sensitive authentication token for accessing this virtual machine's console.
*
* [source]
* ----
* POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket
* ----
*
* The client-provided action optionally includes a desired ticket value and/or an expiry time in seconds.
*
* In any case, the response specifies the actual ticket value and expiry used.
*
* [source,xml]
* ----
*
*
* abcd12345
* 120
*
*
* ----
*
* @author Martin Betak
* @date 21 Nov 2016
* @status added
* @since 4.1
*/
interface Ticket {
/**
* The generated ticket that can be used to access this console.
*
* @author Martin Betak
* @date 21 Nov 2016
* @status added
* @since 4.1
*/
@In @Out types.Ticket ticket();
}
/**
* Generates the file which is compatible with `remote-viewer` client.
*
* Use the following request to generate remote viewer connection file of the graphics console.
* Note that this action generates the file only if virtual machine is running.
*
* [source]
* ----
* POST /ovirt-engine/api/vms/123/graphicsconsoles/456/remoteviewerconnectionfile
* ----
*
* The `remoteviewerconnectionfile` action does not take any action specific parameters,
* so the request body should contain an empty `action`:
*
* [source,xml]
* ----
*
*
* [virt-viewer]
* type=spice
* host=192.168.1.101
* port=-1
* password=123456789
* delete-this-file=1
* fullscreen=0
* toggle-fullscreen=shift+f11
* release-cursor=shift+f12
* secure-attention=ctrl+alt+end
* tls-port=5900
* enable-smartcard=0
* enable-usb-autoshare=0
* usb-filter=null
* tls-ciphers=DEFAULT
* host-subject=O=local,CN=example.com
* ca=...
*
*
* ----
*
* E.g., to fetch the content of remote viewer connection file and save it into temporary file, user can use
* oVirt Python SDK as follows:
*
* [source,python]
* ----
* # Find the virtual machine:
* vm = vms_service.list(search='name=myvm')[0]
*
* # Locate the service that manages the virtual machine, as that is where
* # the locators are defined:
* vm_service = vms_service.vm_service(vm.id)
*
* # Find the graphic console of the virtual machine:
* graphics_consoles_service = vm_service.graphics_consoles_service()
* graphics_console = graphics_consoles_service.list()[0]
*
* # Generate the remote viewer connection file:
* console_service = graphics_consoles_service.console_service(graphics_console.id)
* remote_viewer_connection_file = console_service.remote_viewer_connection_file()
*
* # Write the content to file "/tmp/remote_viewer_connection_file.vv"
* path = "/tmp/remote_viewer_connection_file.vv"
* with open(path, "w") as f:
* f.write(remote_viewer_connection_file)
* ----
*
* When you create the remote viewer connection file, then you can connect to virtual machine graphic console,
* as follows:
*
* [source,bash]
* ----
* #!/bin/sh -ex
*
* remote-viewer --ovirt-ca-file=/etc/pki/ovirt-engine/ca.pem /tmp/remote_viewer_connection_file.vv
* ----
*
* @author Ondra Machacek
* @date 31 Oct 2016
* @status added
* @since 4.1
*/
interface RemoteViewerConnectionFile {
/**
* Contains the file which is compatible with `remote-viewer` client.
*
* User can use the content of this attribute to create a file, which can be passed to `remote-viewer` client to
* connect to virtual machine graphic console.
*
* @author Ondra Machacek
* @date 31 Oct 2016
* @status added
* @since 4.1
*/
@Out String remoteViewerConnectionFile();
}
/**
* Remove the graphics console from the virtual machine.
*
* @author Ondra Machacek
* @date 31 Oct 2016
* @status added
*/
interface Remove {
/**
* Indicates if the remove should be performed asynchronously.
*/
@In Boolean async();
}
}