New-PveNodesQemuVncproxy
Creates a TCP VNC proxy connections.
API: POST /nodes/{node}/qemu/{vmid}/vncproxy, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveNodesQemuVncproxy [-PveTicket <PveTicket>] [-GeneratePassword <bool>] -Node <string> -Vmid <int> [-Websocket <bool>] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-GeneratePassword |
bool |
No | Deprecated, do not use. Password is generated when required. |
-Node |
string |
Yes | The cluster node name. |
-Vmid |
int |
Yes | The (unique) ID of the VM. |
-Websocket |
bool |
No | Prepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible). |
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
Section titled “Output”A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.
