PowerCLI Reference



This cmdlet opens a window to the virtual machine's console.


Open-VMConsoleWindow [-VM] <RemoteConsoleVM[]> [-FullScreen] [-Server <VIConnection[]>] [-UrlOnly] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet opens a window to the virtual machine's console.


NameTypeDescriptionRequired?Pipeline InputDefault Value
VMRemoteConsoleVM[]Specifies the virtual machine for which you want to open a remote console. Supports vCloud and vSphere virtual machines.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
FullScreenSwitchParameterIf specified, opens the virtual machine's console window in full-screen mode.falseFalse
ServerVIConnection[]Specifies the vCenter Server systems or cloud server instances on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.falseFalse
UrlOnlySwitchParameterIf specified, the cmdlet returns the URL for opening a console window to the virtual machine without actually opening the console window.

Note: The URL is valid for 30 seconds. After 30 seconds, the screen authentication ticket contained in the URL expires.
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type


The VM parameter accepts powered-on vSphere and vCloud Director virtual machines. This cmdlet assumes that either VMware Remote Console, VMware Workstation or VMware Fusion is installed.


-------------------------- Example 1 --------------------------

Get-CIVM myVM | Open-VMConsoleWindow -FullScreen

Opens the console of the specified virtual machine in full-screen mode.

Copyright © VMware, Inc. All rights reserved.