Skip to content

New-PveNodesTermproxy

Creates a VNC Shell proxy.

API: POST /nodes/{node}/termproxy, Proxmox VE API viewer

New-PveNodesTermproxy
[-PveTicket <PveTicket>]
[-Cmd <string>]
[-CmdOpts <string>]
-Node <string>
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Cmd string No Run specific command or default to login (requires ‘root@pam’) Values: ceph_install, login, upgrade.
-CmdOpts string No Add parameters to a command. Encoded as null terminated strings.
-Node string Yes The cluster node name.

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.

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