Open-VMConsoleWindow Command | Vmware PowerCLI Reference

Open-VMConsoleWindow

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

Syntax

Open-VMConsoleWindow
[-FullScreen ]
[-Server < VIConnection[] > ]
[-UrlOnly ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VM RemoteConsoleVM[] named
  • pipeline
Specifies the virtual machine for which you want to open a remote console. Supports vCloud and vSphere virtual machines.
optional FullScreen SwitchParameter named
If specified, opens the virtual machine's console window in full-screen mode.
optional Server VIConnection[] named
Specifies the vCenter Server systems or cloud server instances on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
optional UrlOnly SwitchParameter named
If 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.

Output

System.String

Examples

Example 1

Get-CIVM myVM | Open-VMConsoleWindow -FullScreen

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

Related Commands

VM

This cmdlet retrieves the virtual machines on a vCenter Server system.

This cmdlet moves virtual machines to another location.

This cmdlet creates a new virtual machine.

This cmdlet removes the specified virtual machines from the vCenter Server system.

This cmdlet restarts the specified virtual machines.

This cmdlet modifies the configuration of the virtual machine.

This cmdlet powers on virtual machines.

This cmdlet powers off virtual machines.

This cmdlet suspends virtual machines.

This cmdlet unlocks the specified virtual machine.

VMConsoleWindow

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

VMGuest

This cmdlet retrieves the guest operating systems of the specified virtual machines.

This cmdlet restarts the virtual machine guest operating systems.

This cmdlet shuts down the specified virtual machine guest OS.

This cmdlet suspends the specified guest operating systems.

VMGuestDisk

This cmdlet retrieves storage volumes as seen by the virtual machines' guest operating systems.

VMGuestFile

This cmdlet copies files and folders from and to the guest OS of the specified virtual machines using VMware Tools.

VMQuestion

This cmdlet retrieves the pending questions for the specified virtual machines.

This cmdlet answers the specified virtual machine question.

VMResourceConfiguration

This cmdlet retrieves information about the resource allocation between the selected virtual machines.

This cmdlet configures resource allocation between the virtual machines.

VMScript

This cmdlet runs a script in the guest OS of each of the specified virtual machines.

VMStartPolicy

This cmdlet retrieves the start policy of the virtual machines on a vCenter Server system.

This cmdlet modifies the virtual machine start policy.