Open-VMConsoleWindow

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

Syntax

-VM  <RemoteConsoleVM[]>
[-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.

    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

    Feedback

    Was this page helpful?