diff --git a/images/vnc-console-warning.png b/images/vnc-console-warning.png new file mode 100644 index 0000000000..cd6e5d14a9 Binary files /dev/null and b/images/vnc-console-warning.png differ diff --git a/modules/virt-connecting-to-vm-console-web.adoc b/modules/virt-connecting-to-vm-console-web.adoc index 0f2bd711c4..8d3bfb5b12 100644 --- a/modules/virt-connecting-to-vm-console-web.adoc +++ b/modules/virt-connecting-to-vm-console-web.adoc @@ -49,6 +49,14 @@ endif::[] . On the *Virtualization* -> *VirtualMachines* page, click a VM to open the *VirtualMachine details* page. . Click the *Console* tab. The VNC console session starts automatically. ++ +[IMPORTANT] +==== +Only one connection to the VNC console is possible at a time. If you attempt to create a second connection to the same VNC console, a warning is displayed, and you are prompted to disconnect the existing session before you create the new session. + +image::vnc-console-warning.png[] +==== + ifdef::desktop-viewer,serial-console[] . Click *Disconnect* to end the VNC console session. Otherwise, the VNC console session continues to run in the background. . Select *{console-menu}* from the console list. diff --git a/modules/virt-connecting-vm-virtctl.adoc b/modules/virt-connecting-vm-virtctl.adoc index 9ebace48e0..bc80bebd82 100644 --- a/modules/virt-connecting-vm-virtctl.adoc +++ b/modules/virt-connecting-vm-virtctl.adoc @@ -45,11 +45,29 @@ ifdef::vnc-console[] + [source,terminal] ---- -$ virtctl vnc +$ virtctl vnc -n --preserve-session ---- ++ +where: ++ +:: The name of the VM. ++ +:: The namespace that contains the VM. ++ +--preserve-session:: Prevents an existing VNC console connection from being disconnected if you attempt to start a new session. ++ +Only one connection to the VNC console is possible at a time. If you attempt to create a second connection to the same VNC console, an error is displayed and the connection fails. ++ +Example error message: ++ +[source,terminal] +---- +can't access VMI example-vm: Internal error occurred: Can't connect to websocket (503): websocket: bad handshake: application info: Active VNC connection. Request denied. +---- ++ +If you attempt to create a second connection to the same VNC console without using the `--preserve-session` flag, this forces the existing connection to disconnect to allow the new connection. -. If the connection fails, run the following command to collect -troubleshooting information: +. If the connection fails, run the following command to collect troubleshooting information: + [source,terminal] ---- diff --git a/virt/managing_vms/virt-accessing-vm-consoles.adoc b/virt/managing_vms/virt-accessing-vm-consoles.adoc index 6f20291086..be2615f88a 100644 --- a/virt/managing_vms/virt-accessing-vm-consoles.adoc +++ b/virt/managing_vms/virt-accessing-vm-consoles.adoc @@ -16,7 +16,7 @@ You can connect to the following consoles to access running virtual machines (VM [id="vnc-console_virt-accessing-vm-consoles"] == Connecting to the VNC console -You can connect to the VNC console of a virtual machine by using the {product-title} web console or the `virtctl` command-line tool. +You can connect to the Virtual Network Computing (VNC) console of a VM by using the {product-title} web console or the `virtctl` command-line tool. :context: vnc-console include::modules/virt-connecting-to-vm-console-web.adoc[leveloffset=+2] @@ -52,4 +52,4 @@ You can connect to a Windows virtual machine (VM) by using the desktop viewer an :context: desktop-viewer include::modules/virt-connecting-to-vm-console-web.adoc[leveloffset=+2] -:context: virt-accessing-vm-consoles \ No newline at end of file +:context: virt-accessing-vm-consoles