Get-PveNodesVncwebsocket
Opens a websocket for VNC traffic.
API: GET /nodes/{node}/vncwebsocket, Proxmox VE API viewer
Syntax
Section titled “Syntax”Get-PveNodesVncwebsocket [-PveTicket <PveTicket>] -Node <string> -Port <int> -Vncticket <string> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Node |
string |
Yes | The cluster node name. |
-Port |
int |
Yes | Port number returned by previous ‘vncshell’ call. |
-Vncticket |
string |
Yes | Ticket from previous call to ‘vncshell’. |
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.
