configure vm vnc

configure vm vm_name vnc [none | vnc_display]


Configures the VNC display for a virtual machine (VM).

Syntax Description

vm Designates a virtual machine.
vm_name Specifies the VM name to configure the VNC display for.
vnc Specifies providing a display number for VNC access.
none Disables VNC access (default).
vnc_display Specifies the VNC screen number. Range is 0–15.


By default, VNC access is disabled.

Usage Guidelines

For the VNC display number (or screen number), you can use the values from 0 to 15. These correspond to TCP ports 5,900 to 5,915.

Multiple VMs can be configured with the same VNC display, but VMs configured with the same display number cannot run at the same time. A VM cannot be started if the VNC port is already in use.

For security reasons, the VNC display is only accessible using SSH tunnel.


The following example enables VNC on VM "vm1" with display number 3:

# configure vm vm1 vnc 3


This command was first available in ExtremeXOS 30.5.

Platform Availability

This command is available on all platforms that support the Integrated Application Hosting (IAH) feature and have a Core or Premier license installed. For a list of platforms that support the IAH feature and for information about licenses, see the ExtremeXOS and Switch Engine 31.7 Feature License Requirements .