New-PveAccessVncticket
verify VNC authentication ticket.
API: POST /access/vncticket, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveAccessVncticket [-PveTicket <PveTicket>] -Authid <string> -Path <string> [-Port <int>] -Privs <string> -Vncticket <string> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Authid |
string |
Yes | UserId or token. |
-Path |
string |
Yes | Verify ticket, and check if user have access ‘privs’ on ‘path’. |
-Port |
int |
No | Verify that the ticket is valid for this port. |
-Privs |
string |
Yes | Verify ticket, and check if user have access ‘privs’ on ‘path’. |
-Vncticket |
string |
Yes | The VNC ticket. |
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.
