6.268. VmGraphicsConsole

仮想マシンのグラフィックコンソール設定を取得します。

GET /ovit-engine/api/vms/123/graphicsconsoles/456?current=true

remote-viewer クライアントと互換性のあるファイルを生成します。

次のリクエストを使用して、グラフィックコンソールのリモートビューアー接続ファイルを生成します。このアクションは、仮想マシンが実行されている場合にのみファイルを生成することに注意してください。

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/remoteviewerconnectionfile

remoteviewerconnectionfile アクションはアクション固有のパラメーターを取らないので、リクエスト本文は空の action を含む必要があります。

<action/>

応答には、remote-viewer クライアントで使用できるファイルが含まれています。

<action>
  <remote_viewer_connection_file>
    [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=...
  </remote_viewer_connection_file>
</action>

たとえば、リモートビューアー接続ファイルのコンテンツを取得して一時ファイルに保存するには、ユーザーは次のように oVirt Python SDK を使用できます。

# 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)

リモートビューアー接続ファイルを作成すると、次のように仮想マシングラフィックコンソールに接続できます。

#!/bin/sh -ex

remote-viewer --ovirt-ca-file=/etc/pki/ovirt-engine/ca.pem /tmp/remote_viewer_connection_file.vv

仮想マシンからグラフィックコンソールを削除します。

この仮想マシンのコンソールにアクセスするための時間制約のある認証トークンを生成します。

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket

クライアント指定のアクションには、必要に応じて、必要なチケット値および/または有効期限 (秒単位) が含まれます。

いずれの場合も、応答は実際に使用されたチケットの値と有効期限を指定します。

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>