New-PveNodesLxcVncproxy

Creates a TCP VNC proxy connections.

API: POST /nodes/{node}/lxc/{vmid}/vncproxy, Proxmox VE API viewer

Syntax

New-PveNodesLxcVncproxy
    [-PveTicket <PveTicket>]
    [-Height <int>]
    -Node <string>
    -Vmid <int>
    [-Websocket <bool>]
    [-Width <int>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Height	int	No	sets the height of the console in pixels.
-Node	string	Yes	The cluster node name.
-Vmid	int	Yes	The (unique) ID of the VM.
-Websocket	bool	No	use websocket instead of standard VNC.
-Width	int	No	sets the width of the console in pixels.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

Output

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.